home *** CD-ROM | disk | FTP | other *** search
/ Internet Info 1994 March / Internet Info CD-ROM (Walnut Creek) (March 1994).iso / networking / terms / kermit / b / iktker.doc < prev    next >
Encoding:
Text File  |  1993-06-25  |  141.9 KB  |  2,995 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.                   IBM SYSTEM/370 MVS/TSO KERMIT USER'S GUIDE
  17.  
  18.  
  19.                                   VERSION 4.2
  20.  
  21.  
  22.                                  John Chandler
  23.  
  24.                   Harvard/Smithsonian Center for Astrophysics
  25.  
  26.                                  May 26, 1993
  27.  
  28.  
  29.  
  30.                             Copyright (C) 1981,1993
  31.             Trustees of Columbia University in the City of New York
  32.  
  33.      Permission is granted to any individual or institution to use, copy,
  34.     or redistribute this document so long as it is not sold for profit, and
  35.                   provided this copyright notice is retained.
  36.                                Table of Contents
  37.  
  38. 1. IBM 370 KERMIT                                                             1
  39.  
  40.    1.1. Translation Tables                                                    1
  41.    1.2. File Attributes                                                       2
  42.    1.3. Program Operation                                                     2
  43.    1.4. Kermit-370 Subcommands                                                3
  44.    1.5. Before Connecting to the Mainframe                                    9
  45.    1.6. Trouble-shooting Protocol Converters                                  9
  46.    1.7. After Returning from Kermit-370                                      10
  47.    1.8. What's New                                                           10
  48.    1.9. What's Missing                                                       11
  49.    1.10. Further Reading                                                     11
  50.  
  51. 2. IBM MVS/TSO KERMIT                                                        12
  52.  
  53.    2.1. The MVS/TSO File System                                              12
  54.    2.2. Program Operation                                                    13
  55.    2.3. Kermit-TSO Subcommands                                               13
  56.    2.4. How to build an executable Kermit-TSO                                14
  57.    2.5. What's New                                                           15
  58.    2.6. What's Missing                                                       15
  59.  
  60. Index                                                                        16
  61.                                 List of Tables
  62.  
  63.    Table 1-1:   Allowed character set combinations in Kermit-370              1
  64.    Table 1-2:   EBCDIC (hexadecimal) code points for LATIN1                   2
  65.    Table 1-3:   Character graphics for EBCDIC codes                           2
  66.    Table 1-4:   Error messages and codes for Kermit-370                      10
  67. 1. IBM 370 KERMIT
  68.  
  69. Program:       John  Chandler  (Harvard/Smithsonian  Center  for Astrophysics);
  70.                contributions from Vace Kundakci and Daphne Tzoar (Columbia  U),
  71.                Bob  Shields  (U.  Maryland),  Greg  Small  (UC Berkeley), Clark
  72.                Frazier (Harvard Bus. Sch.), Bob  Bolch  and  Steve  Blankinship
  73.                (Triangle),  Ron  Rusnak  (U.  Chicago),  Roger  Fajman and Dale
  74.                Wright (NIH), Andre Pirard (U. Liege),  Pierre  Goyette  (McGill
  75.                U.)
  76. Language:      IBM 370 Assembler
  77. Documentation: John Chandler (CfA)
  78. Version:       4.2.3
  79. Date:          1993 May
  80.  
  81. Kermit-370  is  a  family  of  programs  implementing  the KERMIT file transfer
  82. protocol for IBM 370-series mainframes (System/370,  303x,  43xx,  308x,  3090,
  83. etc.)  under  a  variety  of  operating  systems.    Kermit-370  operates  over
  84. asynchronous ASCII communication lines attached to a 3705-style or protocol en-
  85. veloping  3708  front  end  ("TTY" or line-mode devices), to a Series/1 or 4994
  86. running the Yale ASCII Terminal Communication System  or  the  IBM  7171  ASCII
  87. Device  Control Unit or a 9370 with ASCII subsystem ("SERIES1" devices), to the
  88. IBM 3174 protocol converter at level B2.0 or  higher  ("AEA"  devices),  or  to
  89. front-ends with graphics pass-through mode, such as the Datastream/Leedata 8010
  90. and PCI 1076 ("GRAPHICS" devices).  As of this writing, the  pending  implemen-
  91. tation  of  full(er)  7171 compatibility in the program product SIM3278 has not
  92. been completed.    The  non-line-mode  devices  are  often  called  full-screen
  93. devices.  For more details on front ends, see the section SET CONTROLLER.
  94.  
  95. The  source is coded in IBM 370 assembly language and is compatible with the F,
  96. VS, and H assemblers.  The code is divided into sections, some generic and some
  97. specific  to  an individual operating system.  While the details of file-system
  98. and supervisor interaction vary widely among  the  systems  available  for  IBM
  99. 370's, the basic features are essentially the same.  This chapter describes the
  100. features common to all variants of Kermit-370, and a separate chapter will deal
  101. with the system-specific details for each variant.
  102.  
  103. IBM  370 systems have some peculiarities that users should be aware of.  First,
  104. these systems are essentially half-duplex; the communication  line  must  "turn
  105. around"  before  any  data  can  be  sent.    The  "TTY"  devices  are strictly
  106. half-duplex, and even the "SERIES1", "GRAPHICS", and  "AEA"  devices,  although
  107. they  maintain  full-duplex  communication  with  the terminal, must transmit a
  108. block at a time to the mainframe.  The fact that a  packet  has  been  received
  109. from the IBM system through a "TTY" device is no guarantee that it is ready for
  110. a reply; generally, the true indicator of  readiness  is  the  line  turnaround
  111. character  (XON), which the operating system sends immediately before issuing a
  112. read request.  On some systems, however, it is possible for Kermit to  do  away
  113. with  the  system-supplied  turnaround  and  schedule read requests immediately
  114. after the corresponding writes.  It is up to the user to tell the other  Kermit
  115. how it must conform to the requirements of the IBM mainframe.
  116.  
  117. A  second distinction is that disk files are encoded using the EBCDIC character
  118. set.  Consequently, there are three layers of character translation on  packets
  119. exchanged  on  a  "TTY"  device.    For  an incoming packet, the outer layer is
  120. provided by the operating system, which translates all characters from ASCII to
  121. EBCDIC.    Kermit-370 must then translate the packets back to ASCII (the middle
  122. layer) in order to calculate and verify the checksum.  Data arriving through  a
  123. "SERIES1",  "GRAPHICS", or "AEA" device are still in ASCII and therefore bypass
  124. the two outer layers.  In any case, Kermit-370 translates  text  files  finally
  125. into  EBCDIC (the inner layer) before storing on disk.  When Kermit-370 sends a
  126. file, the opposite translations occur.  The middle-layer tables used by  Kermit
  127. must  be  the  inverses  of the corresponding outer-layer ones used by the host
  128. operating system if file transfers are to work at all.  If necessary, the  sys-
  129. tem  programmer  should  add the appropriate SET TATOE/TETOA/TTABLE subcommands
  130. (q.v.)  to the global INIT file.  Indeed, it is usually  a  good  idea  to  set
  131. TTABLE  ON  in  the  global INIT file to force using different built-in sets of
  132. tables for the inner and middle layers whenever the system has  "TTY"  devices.
  133. The standard 7-bit ASCII-to-EBCDIC translations can be found in the Appendix or
  134. the IBM System/370 Reference Card.  See the section  "Translation  Tables"  for
  135. more details.
  136.  
  137. Another  distinction  of  IBM  370's  is  that they store and retrieve files as
  138. records rather than byte streams.  Records may be either fixed-length with some
  139. sort of padding (as needed) or varying-length with some sort of (generally hid-
  140. den) delimiters.  Thus, Kermit-370 must assemble  incoming  data  packets  into
  141. records  by  stripping  off carriage return-linefeed pairs (CRLF's) and padding
  142. with blanks or truncating as needed and must strip trailing blanks  and  append
  143. CRLF's to outgoing records.  (See the SET FILE TYPE subcommand.)  Further, disk
  144. files typically have the records combined into blocks for efficiency.  One con-
  145. sequence  of  this form of storage is that files have attributes describing the
  146. component records: maximum record length (LRECL), record  format  (RECFM),  and
  147. sometimes block size (BLKSIZE).
  148.  
  149. As  mentioned before, Kermit-370 is a family of programs.  At present, only the
  150. CMS, TSO, MUSIC, ROSCOE, and CICS variants are operational.  Variants for DOS-4
  151. and MTS have at least reached the "drawing board," but no others have even been
  152. started as of this writing.  Volunteers are always welcome to  port  Kermit-370
  153. to  other operating systems or add new features to the existing family.  Anyone
  154. interested should first get in touch with the Center for  Computing  Activities
  155. at  Columbia  University  to find out what projects of a similar nature are al-
  156. ready pending (and thereby prevent unnecessary duplication of effort).    There
  157. are  supplemental  files in the Kermit distribution with explanations of how to
  158. go about porting Kermit-370 and how to add support for new terminal  controller
  159. types.    For  details, refer to the installation guide for the variant of your
  160. choice.
  161.  
  162.  
  163. 1.1. Translation Tables
  164.  
  165. Traditionally, IBM mainframe Kermits have translated 7-bit ASCII characters  to
  166. 8-bit   EBCDIC  characters  and  ignored  the  "parity"  bit  in  the  process.
  167. Similarly, the 8-bit EBCDIC characters  have  been  mapped  onto  7-bit  ASCII,
  168. thereby  producing  many  ambiguities  in  translating  the ASCII files back to
  169. EBCDIC.  These ambiguities fall into  two  categories:  EBCDIC  characters  not
  170. representable  in ASCII have been rendered as ASCII nulls, and alternate EBCDIC
  171. representations of characters such as the  ASCII  backslash  have  been  mapped
  172. together,  but  at  least no two 7-bit ASCII characters are translated into the
  173. same EBCDIC character.  The ambiguities were tolerable  in  environments  where
  174. the  traditionally  non-printable  characters never occurred in text files, but
  175. text processing has increasingly tended to include such  characters  for  math-
  176. ematical  formulas or for languages other than English.  Ultimately, the trans-
  177. lation tables must become completely invertible, lest information  be  lost  in
  178. the  transfer.    There  has long been an option to replace parts of the trans-
  179. lation tables via commands from the user (or imbedded in the INIT  files),  but
  180. such  replacements were always supported locally and were, therefore, basically
  181. non-standard.
  182.  
  183. The concept of standard translations is currently in a state of flux because of
  184. the  proliferation  of 8-bit code pages and the countervailing efforts at stan-
  185. dardization among groups such as the ISO and Kermit developers.  In particular,
  186. Kermit-370  now  supports  a set of EBCDIC and "extended ASCII" code pages with
  187. built-in translation tables and automatic identification of the "ASCII"  trans-
  188. fer  character  set via Attribute packets.  This facility supports files stored
  189. using numerous IBM Country Extended Code  Pages  and  permits  transfers  using
  190. character  sets  ASCII,  CYRILLIC,  GREEK, HEBREW, JAPAN-EUC, KATAKANA, LATIN1,
  191. LATIN2, LATIN3, and THAI.  See Table 1-1 for a display of the allowed  combina-
  192. tions  of  character  sets.  See also file ISOK7.TXT in the Kermit distribution
  193. for a somewhat outdated description of the  protocol  extensions.    Kermit-370
  194. currently supports text files in the following languages:  Afrikaans, Albanian,
  195. Bulgarian, Byelorussian, Catalan,  Czech,  Croatian,  Danish,  Dutch,  English,
  196. Esperanto,  Faeroese, Finnish, French, Gaelic, Galician, German, Greek, Hebrew,
  197. Hungarian, Icelandic, Italian,  Japanese  (Katakana  and  Kanji),  Lao,  Latin,
  198. Macedonian, Maltese, Norwegian, Polish, Portuguese, Quechua, Romanian, Russian,
  199. Serbian, Slovak, Slovene, Spanish, Swahili, Swedish, Thai, Turkish,  Ukrainian,
  200. and Volapuk.  Visual representations of the characters sets may be found in the
  201. ISO register (for transfer) and in various IBM  documents,  such  as  S544-3156
  202. "About Type" (for files).
  203.  
  204. -------------------------------------------------------------------------------
  205.  
  206.                             Transfer character set
  207.  
  208.   Local  ASCII CYRILLIC GREEK HEBREW JAPAN KATAK.  L1 L2 L3 THAI
  209.  
  210.  CP037     *                                       **
  211.  CP273                                             **
  212.  CP275                                             **
  213.  CP277                                             **
  214.  CP278                                             **
  215.  CP280                                             **
  216.  CP281                                 *           **
  217.  CP282                                             **
  218.  CP284                                             **
  219.  CP285                                             **
  220.  CP290                                 *     **
  221.  CP297                                             **
  222.  CP424                          **
  223.  CP500     *                           *           **
  224.  CP838                                                       **
  225.  CP870                                                **
  226.  CP871                                             **
  227.  CP875                    **
  228.  CP880     *      **
  229.  CP905                                                   **
  230.  CZECH                                                 *
  231.  DKOI      *      ***
  232.  EBCDIC    **                                     ***
  233.  H-EBCD                                *      *
  234.  KANJI                                 *
  235.  
  236.          Table 1-1:  Allowed character set combinations in Kermit-370
  237.  
  238. All   allowed  combinations  are  marked  with  asterisks,  and  the  preferred
  239. combination in each row or column is the one with the most asterisks.  Whenever
  240. a  character  set is specified, either directly or through an Attribute packet,
  241. the other category of character set is checked to see if it makes up an allowed
  242. combination.  If not, it is forced to the preferred character set.
  243.  
  244. -------------------------------------------------------------------------------
  245.  
  246. As  nearly as possible, the tables in Kermit-370 are invertible, but all of the
  247. character sets reserve many (typically 65) code points for  control  characters
  248. and  leave them officially undefined and unprintable.  This applies both to IBM
  249. code pages and ISO standard 8-bit character sets.  Although 33 of the  controls
  250. have widely accepted mappings, the others do not, and Kermit-370 currently uses
  251. those given in an appendix of IBM's VS/Fortran Reference Manual.   Needless  to
  252. say, such translations are arbitrary and may be invalidated by future decisions
  253. at IBM or ISO.  Still, most of the translations are likely to be stable in  the
  254. long run.  Table 1-2 shows the current translation from LATIN1 to EBCDIC, which
  255. is likely to be the most often used.  Other translations, including the reverse
  256. ones, may be displayed using the TDUMP subcommand of Kermit-370.
  257.  
  258. Besides converting files for transmission, Kermit-370 must also  compensate for
  259. the EBCDIC/ASCII translation performed by some front ends and must,  therefore,
  260. be able to apply the exact reverse translations on both input and output.  This
  261. is the "middle layer" of translation described earlier for "TTY" devices.  Con-
  262. sider  the  fate  of  a Left Square Bracket character in an inbound packet on a
  263. "TTY" line.  It begins as ASCII code x'5B' (91  decimal),  but  the  front  end
  264. translates  it  to EBCDIC before presenting it to Kermit-370.  In this example,
  265. suppose it becomes EBCDIC code x'4A' (74 decimal) instead of the standard x'AD'
  266. (173  decimal).    Then,  Kermit must be primed with a SET TETOA 74 91 so that,
  267.  
  268. -------------------------------------------------------------------------------
  269.  
  270.       -0 -1 -2 -3 -4 -5 -6 -7 -8 -9 -A -B -C -D -E -F
  271.  
  272.   0-  00 01 02 03 37 2D 2E 2F 16 05 25 0B 0C 0D 0E 0F
  273.   1-  10 11 12 13 3C 3D 32 26 18 19 3F 27 1C 1D 1E 1F
  274.   2-  40 5A 7F 7B 5B 6C 50 7D 4D 5D 5C 4E 6B 60 4B 61
  275.   3-  F0 F1 F2 F3 F4 F5 F6 F7 F8 F9 7A 5E 4C 7E 6E 6F
  276.   4-  7C C1 C2 C3 C4 C5 C6 C7 C8 C9 D1 D2 D3 D4 D5 D6
  277.   5-  D7 D8 D9 E2 E3 E4 E5 E6 E7 E8 E9 AD E0 BD 5F 6D
  278.   6-  79 81 82 83 84 85 86 87 88 89 91 92 93 94 95 96
  279.   7-  97 98 99 A2 A3 A4 A5 A6 A7 A8 A9 C0 4F D0 A1 07
  280.   8-  20 21 22 23 24 15 06 17 28 29 2A 2B 2C 09 0A 1B
  281.   9-  30 31 1A 33 34 35 36 08 38 39 3A 3B 04 14 3E FF
  282.   A-  41 AA 4A B1 9F B2 6A B5 BB B4 9A 8A B0 CA AF BC
  283.   B-  90 8F EA FA BE A0 B6 B3 9D DA 9B 8B B7 B8 B9 AB
  284.   C-  64 65 62 66 63 67 9E 68 74 71 72 73 78 75 76 77
  285.   D-  AC 69 ED EE EB EF EC BF 80 FD FE FB FC BA AE 59
  286.   E-  44 45 42 46 43 47 9C 48 54 51 52 53 58 55 56 57
  287.   F-  8C 49 CD CE CB CF CC E1 70 DD DE DB DC 8D 8E DF
  288.  
  289.  
  290.             Table 1-2:  EBCDIC (hexadecimal) code points for LATIN1
  291.  
  292. This  table  shows  the values of the EBCDIC equivalents for the code points in
  293. the LATIN1 character  set.    The  values  are  arranged  in  LATIN1  collating
  294. sequence,  and  the  rows  and  columns  are  labeled with the first and second
  295. digits, respectively, of the LATIN1 code points.  For example, LATIN1  code  41
  296. (hex)  is  upper-case "A", and the intersection of row "4-" and column "-1" has
  297. the value C1 (hex), which is the EBCDIC code for "A".  Rows "0-",  "1-",  "8-",
  298. and  "9-" are officially undefined in ISO 8859-1 and so, in principle, could be
  299. changed at some future time, especially "8-" and "9-".  Note  that  this  table
  300. uses  a  format  close  to  that of the TDUMP subcommand and of the Kermit code
  301. itself, but character-set tables are often displayed with the rows and  columns
  302. interchanged.
  303.  
  304. -------------------------------------------------------------------------------
  305.  
  306. when reconstructing the original ASCII  packet,  the  character  becomes  x'5B'
  307. again.   Otherwise, the packet checksum will appear invalid.  Kermit comes with
  308. a pair of default tables, but it may be necessary to customize  them,  as  this
  309. example  shows.    The following procedure will reveal any changes needed.  The
  310. procedure has two stages: the first is for any line-mode  front  end,  and  the
  311. second only for front ends capable of full 8-bit data transfer.  Note that, al-
  312. though the discussion refers to hexadecimal values, the Kermit-370 SET  subcom-
  313. mands  require  decimal  numeric arguments.  Also, note that this procedure as-
  314. sumes you will run  Kermit  with  TTABLE  set  on;  hence,  the  references  to
  315. Kermit-370  tables  are  to  TATOE and TETOA.  If you choose to define Kermit's
  316. file translation to match that of the front end, you should  leave  TTABLE  set
  317. off  and  remove  the  T's from the SET subcommands described below.  This will
  318. also turn off the automatic switching of translation tables  according  to  the
  319. Attribute  packets received from the other Kermit.  Under CMS, you must issue a
  320. CMS SET INPUT and a CMS SET OUTPUT before starting this procedure.
  321.  
  322.    1. Create a file containing all the non-control EBCDIC characters  (hex
  323.       codes  40-FF)  and  display the file on any available ASCII terminal
  324.       hooked up to the line-mode front end in question.
  325.  
  326.    2. If any printable ASCII character is missing from the display, Kermit
  327.       cannot  work through this front end (unless you modify the tables in
  328.       the front end itself).
  329.  
  330.    3. If any ASCII character appears twice, there is no cause for alarm.
  331.  
  332.    4. If any ASCII character does not appear where it should, according to
  333.       Table  1-3,  a SET TATOE must be added to the system INIT file.  For
  334.       example, if EBCDIC code 5F (Not Sign, according to the Appendix) ap-
  335.       pears  as an ASCII Tilde (7E), but EBCDIC A1 (Tilde) does not, a SET
  336.       TATOE 126 95 is required.  Warning: characters  considered  unprint-
  337.       able  by  the  front end are likely to be filtered out entirely when
  338.       you display the file; do not expect the display to line up just like
  339.       Table 1-3.
  340.  
  341.    5. Create  a  file  on the mainframe using an ASCII terminal for input,
  342.       and enter all 95 printable ASCII characters in  collating  sequence.
  343.       You  can  presumably  save  time  by  skipping  the  52  upper-  and
  344.       lower-case letters and the 10 digits.
  345.  
  346.    6. Display the file from the previous step in hexadecimal or other  bi-
  347.       nary form.
  348.  
  349.    7. If any duplicates appear among the 95 characters (or 33, if you have
  350.       taken the short cut), Kermit cannot work through this front end (un-
  351.       less you modify the tables in the front end).
  352.  
  353.    8. Compare the hexadecimal codes with rows 2-7 of Table 1-2.  If a dis-
  354.       crepancy appears, a SET TETOA must be added to the system INIT file.
  355.       For  example, if ASCII Left Bracket (5B) appears as EBCDIC 4A, a SET
  356.       TETOA 74 91 is needed.  At this point, the first stage is complete.
  357.  
  358.    9. If 8-bit line-mode file transfer is desired, you must now verify the
  359.       extended  character  set.    Display the file of EBCDIC codes again,
  360.       this time using a terminal with extended character set  display,  or
  361.       capture  the  session  with a micro Kermit and display the resulting
  362.       file in hexadecimal.  If any code in the range A0-FE  does  not  ap-
  363.       pear,  the  front  end  will  not allow 8-bit Kermit data transfers.
  364.       Generate SET TATOE entries for the entire range, as needed, just  as
  365.       in  the  example  given  for 7-bit codes.  If the front end's trans-
  366.       lation tables are documented, it may be  easier  to  work  from  the
  367.       manual,  but  you  must  be sure that you have tables for all of the
  368.       translations that occur on the data path.
  369.  
  370.   10. Create a file of the 95 extended ASCII codes A0-FE, if possible,  by
  371.       using a terminal capable of transmitting those codes or transmitting
  372.       a pre-made file "raw".  If necessary, use the  appropriate  table(s)
  373.       in the manual(s) instead.
  374.  
  375.   11. Again,  if  any  duplicates  appear,  this front end is incapable of
  376.       8-bit file transfers.  Otherwise, generate SET TETOA entries as  be-
  377.       fore.
  378.  
  379. -------------------------------------------------------------------------------
  380.  
  381.        0  1  2  3  4  5  6  7  8  9  A  B  C  D  E  F
  382.  
  383.   4-                                    .  <  (  +  |
  384.   5-   &                             !  $  *  )  ;  ^
  385.   6-   -  /                             ,  %  _  >  ?
  386.   7-                              `  :  #  @  '  =  "
  387.   8-      a  b  c  d  e  f  g  h  i
  388.   9-      j  k  l  m  n  o  p  q  r
  389.   A-      ~  s  t  u  v  w  x  y  z           [
  390.   B-                                          ]
  391.   C-   {  A  B  C  D  E  F  G  H  I
  392.   D-   }  J  K  L  M  N  O  P  Q  R
  393.   E-   \     S  T  U  V  W  X  Y  Z
  394.   F-   0  1  2  3  4  5  6  7  8  9
  395.  
  396.  
  397.                 Table 1-3:  Character graphics for EBCDIC codes
  398.  
  399. This  table  shows  the  representations of the EBCDIC codes arranged in EBCDIC
  400. collating sequence, row by row.  Codes  that  do  not  correspond  to  ISO  646
  401. characters (7-bit ASCII), have been left blank.  One special case is the EBCDIC
  402. code 5F, which represents a Not Sign in IBM's CP037, but which is traditionally
  403. mapped  to  the ASCII Circumflex, as shown here.  WARNING: this manual may have
  404. been printed on a  device  that  maps  characters  differently.    Consult  the
  405. Appendix to verify.
  406.  
  407. -------------------------------------------------------------------------------
  408.  
  409.  
  410. 1.2. File Attributes
  411.  
  412. Kermit-370  attempts  to  send and receive file attributes along with the files
  413. themselves.  Before Kermit receives a file, it compares  the  Length  attribute
  414. (if  available)  with the amount of disk space available (if known) so that the
  415. file can be rejected if it will not fit.  In addition, the Type, Access, Encod-
  416. ing,  Disposition,  and  Format attributes, if any, are interpreted in order to
  417. match the received file to the original as nearly as possible.  All  other  at-
  418. tributes (including Date) are simply ignored.  For Type, Kermit recognizes text
  419. and binary specifications; for Access, it recognizes append, normal, and super-
  420. sede;  for Encoding, it recognizes ASCII, extended, and EBCDIC (which it treats
  421. as binary); for Disposition, it recognizes mail, print, and job; and  for  For-
  422. mat,  it  recognizes  text,  D-binary,  V-binary, binary, and LRECL.  Any other
  423. values are rejected.
  424.  
  425. On sending a file, if the other Kermit is willing to accept Attribute  packets,
  426. Kermit-370  sends  the Type, Encoding, Format, Date, and Length attributes (un-
  427. less some or all of them have been disabled -- see the  SET  ATTRIBUTE  subcom-
  428. mand).
  429.  
  430. Unfortunately, the set of file attributes defined in the Kermit protocol is not
  431. well matched to the needs of  IBM  370  file  systems,  so  that  much  of  the
  432. machinery  for  creating and interpreting of Attribute packets is useless.  For
  433. example, the "Format" attribute, which should logically specify the record for-
  434. mat of the received file, gives only the format of the file in transmission and
  435. cannot distinguish between fixed-length and  varying-length  records  for  text
  436. files.    This  limitation  is partly due to the fact that other Kermits do not
  437. generally support the same attributes.  In short, even if the protocol made  it
  438. possible,  some  of  the  important attributes would never be specified anyway.
  439. Nonetheless, efforts are being made to extend the  protocol  to  be  more  com-
  440. prehensive.
  441.  
  442.  
  443. 1.3. Program Operation
  444.  
  445. Kermit-370  can  be  invoked  directly  or from a command procedure.  In either
  446. case, it reads and executes subcommands sequentially until  directed  to  quit,
  447. and  then  returns.    A  subcommand  consists  of  one  or more fields (words)
  448. separated by spaces or commas.
  449.  
  450. Upon startup, the program looks for two (optional)  initialization  files,  one
  451. system-wide  and a second specific to the user.  Both filespecs are, of course,
  452. system-dependent.  The purpose of these files is to allow  Kermit  to  be  cus-
  453. tomized  for  a  particular  system  and for a user's specific settings without
  454. changing the source code.  The system-wide file, which is maintained by a  sys-
  455. tems programmer, should contain Kermit subcommands that all users would need to
  456. issue in order for Kermit to run on the system, such as subcommands  to  modify
  457. the  ASCII/EBCDIC  tables  used by Kermit-370.  The user-specific file, if any,
  458. should contain subcommands that the user generally issues every time Kermit  is
  459. run.    Kermit-370 executes any subcommands found in these files as though they
  460. were typed at the terminal.  Here is a sample INIT file:
  461.  
  462.     * Asterisk in column one is a comment.
  463.     set transfer character-set latin1
  464.     set file collision rename
  465.     set block 3
  466.  
  467. During interactive execution, you may  use  the  built-in  help  feature  while
  468. typing Kermit-370 subcommands.  A question mark ("?") typed at almost any point
  469. in a subcommand, followed by a carriage return, produces a brief description of
  470. what  is  expected or possible at that point.  Moreover, mistyping a subcommand
  471. will generally produce a helpful error message or a list of possible options at
  472. the   point  of  error.    Keywords  in  such  lists  are  displayed  with  the
  473. minimum-length abbreviation in upper case and the remainder, if any,  in  lower
  474. case.  In entering Kermit subcommands, any keyword may be shortened to any sub-
  475. string that contains the minimum abbreviation.
  476.  
  477. Besides knowing the mechanics of entering Kermit subcommands  and  interpreting
  478. responses,  the  user  must  understand  which  subcommands are necessary.  The
  479. default values for Kermit-370 options have, in some cases, been constrained  by
  480. a  desire  for  continuity,  so that some of the default behavior is distinctly
  481. "suboptimal."  An example of this is the traditional  80-byte  default  RECEIVE
  482. packet size, which generally gives much slower transmission than a size of 1000
  483. or more.  Such options are flagged in this chapter with a  notation  that  they
  484. perhaps  ought  to be set in the INIT files.  Note, however, that the interplay
  485. of Kermit protocol sometimes provides a performance upgrade with no special ac-
  486. tion  required  from  the  Kermit-370  user.    An  example of this is the SEND
  487. packet-size, which is always under the control of the other Kermit.  Kermit-370
  488. always  sends  packets as long as the other Kermit allows, unless the frequency
  489. of transmission errors indicates that shorter packets would be  more  efficient
  490. (see the subcommand SET SPEED).
  491.  
  492. Kermit-370 also attempts to produce optimal results by adapting to the file at-
  493. tributes sent by the other Kermit along with the files, such as TYPE and LRECL.
  494. Such  attributes,  when sent by the other Kermit, temporarily override the cur-
  495. rent settings in Kermit-370  during  the  reception  of  the  associated  file.
  496. Potentially  even  more  importantly,  Kermit-370  automatically recognizes the
  497. character set used for the file transfer and  chooses,  if  necessary,  a  com-
  498. patible  character  set  for  file storage.  Table 1-1 shows the currently sup-
  499. ported list of character sets.   As  with  any  automatic  operation,  Kermit's
  500. honoring of the transmitted attributes may need to be suppressed in part or al-
  501. together, and the SET ATTRIBUTE subcommand provides this capability.
  502.  
  503. Another attribute that Kermit-370 supports is file  disposition,  which  allows
  504. files  to be received and immediately retransmitted as electronic mail, sent to
  505. a printer, or submitted as a  batch  job.    These  three  options  are  highly
  506. site-specific  and are implemented as a set of three host commands with similar
  507. calling sequences.  In each case, the command is invoked in two different  ways
  508. in  the  process  of processing the file.  It is called without any filespec or
  509. other  options  as  soon  as  the  corresponding  attribute  is  recognized  by
  510. Kermit-370.    If  the  command is not implemented or for some reason returns a
  511. non-zero completion code (such a code should be negative, if at all  possible),
  512. Kermit-370  rejects  the  file  using  the normal attribute exchange mechanism.
  513. Otherwise, the file is received as usual, and the command is invoked  again  at
  514. the  end-of-file.    The  second  time,  the  command  is given the name of the
  515. received file and the options received from the sending  Kermit  (such  as  the
  516. list  of  recipients for electronic mail).  The command is then responsible for
  517. disposing of the file (and deleting it, if desired).  If, for any  reason,  the
  518. file  cannot  be sent as required, the command should return a negative comple-
  519. tion code (or non-zero, at any rate), and Kermit-370 will send  back  an  error
  520. message  to the sending Kermit.  The command itself should refrain from issuing
  521. any messages of its own or permitting commands that it invokes  to  issue  mes-
  522. sages.    See  the  beginning  of the chapter on the system-specific variant of
  523. Kermit-370 for the exact command syntax.  Some sample implementations  of  such
  524. commands  may  be  available  in  the  Kermit  distribution  --  refer  to  the
  525. system-specific installation guide for a list of samples.
  526.  
  527.  
  528. 1.4. Kermit-370 Subcommands
  529.  
  530. The following is a summary of Kermit subcommands.  The starred subcommands  can
  531. be  issued  as  remote Kermit commands to Kermit-370 when it is in server mode.
  532. System-specific subcommands are omitted from this list.
  533.           BYE      logs out other Kermit server.
  534.           CWD*     establishes a new working directory.
  535.     DIRECTORY      displays all or part of the disk directory.
  536.          ECHO      a line back to the user.
  537.          EXIT      from Kermit-370.
  538.        FINISH      other Kermit server.
  539.           GET      file(s) from a Kermit server.
  540.          GIVE*     creates a TAKE file snapshot of a table.
  541.          HELP      about Kermit-370.
  542.          HOST*     executes a system command.
  543.        KERMIT*     executes a Kermit subcommand.
  544.          QUIT      from Kermit-370.
  545.       RECEIVE      file(s) from other Kermit.
  546.          SEND      file(s) to other Kermit.
  547.        SERVER      mode of remote operation.
  548.           SET*     various parameters.
  549.          SHOW*     various parameters.
  550.         SPACE*     displays disk storage allocation.
  551.        STATUS*     inquiry.
  552.          STOP      easy escape from protocol mode.
  553.          TAKE*     subcommands from file.
  554.         TDUMP*     dumps the contents of a table.
  555.          TYPE*     a file.
  556.         XECHO      echoes a line (transparently).
  557.         XTYPE      displays a file (transparently).
  558.  
  559. Although Kermit-370 is generally a remote Kermit, it has the capability of com-
  560. municating  with  another  Kermit  in  server  mode.    In  that situation, the
  561. subcommand prefixes REMOTE and LOCAL refer to the Kermit server and Kermit-370,
  562. respectively,  even  when  Kermit-370 is, strictly speaking, the remote Kermit.
  563. To help avoid confusion, this chapter will often  use  the  term  "foreign"  to
  564. apply  to  the  Kermit at the other end from Kermit-370.  All the above subcom-
  565. mands may be preceded by the LOCAL prefix, but only certain ones are valid with
  566. REMOTE,  including some not shown here.  See the description of the SERVER sub-
  567. command for details.  Any text replies Kermit-370 gets from the foreign  Kermit
  568. server   are   added   to   a   disk   file  (whose  filespec  is,  of  course,
  569. system-dependent).  Such a transaction can be carried out, for  example,  under
  570. control  of  a  TAKE file if Kermit-370 is not operating locally.  If the local
  571. Kermit has a "magic" character sequence that switches it from  terminal  emula-
  572. tion  to  server  mode,  then  an  entire  session could be controlled from the
  573. mainframe, possibly in response to a single command issued  by  a  naive  user.
  574. For example,
  575.  
  576.     .grab
  577.  
  578.          Kermit-370 is invoked and executes the following TAKE file
  579.  
  580.     ECHO Serve Me!        the local Kermit switches to server mode
  581.     GET file.a            the server uploads file.a
  582.     FINISH                the server switches back to terminal mode
  583.  
  584. The remainder of this section describes subcommands with special meaning or use
  585. in Kermit-370, except the highly system-dependent ones.  For the latter,  refer
  586. to the appropriate chapter.  Subcommands are listed in alphabetical order.
  587.  
  588.  
  589.                         THE ECHO AND XECHO SUBCOMMANDS
  590.  
  591. Syntax: [X]ECHO line
  592.  
  593. These subcommands type the line back at the user.  The line may contain control
  594. characters or any desired text, including upper or lower case.   These  subcom-
  595. mands may be used, for example, to test the ASCII/EBCDIC translate tables or to
  596. issue coded commands to the user's terminal.  XECHO differs from ECHO primarily
  597. in  that  it sends the text as a raw transmission according to the current CON-
  598. TROLLER setting.  Thus, XECHO will, if necessary, break the text into pieces no
  599. larger  than the current SEND PACKET-SIZE and will use transparent mode if CON-
  600. TROLLER is SERIES1, GRAPHICS  or  AEA.    It  also  offers  its  own  brand  of
  601. control-character  quoting,  using  the "^" character to indicate that only the
  602. five low-order bits of the ASCII codes are to be used.  Thus, "^a",  "^A",  and
  603. "^!"  are  all  translated  to  SOH (CTRL-A), while "^[" becomes ESC.  However,
  604. there must be one exception for "^" itself: "^>" and "^~" are  both  translated
  605. to RS (CTRL-^), but "^^" becomes just "^".  XECHO also decodes 8th-bit quoting,
  606. just as in Kermit protocol, and this feature can be disabled by setting 8th-bit
  607. quoting  off.  For example, if the 8th-bit quote character is "&", entering the
  608. subcommand "XECHO &A" will transmit a code x'C1', but the same subcommand  with
  609. quoting off will transmit two bytes: x'2641'.
  610.  
  611.  
  612.                               THE GET SUBCOMMAND
  613.  
  614. Syntax: GET [foreign-filespec [filespec]]
  615.  
  616. The  GET subcommand tells Kermit to request a file or file group from the other
  617. system, which must have a Kermit running in server mode.   Provided  the  other
  618. Kermit  complies,  the  effect is the same as if SEND foreign-filespec had been
  619. issued directly to the other Kermit and RECEIVE [filespec] to Kermit-370.    If
  620. this  subcommand  is  issued  without any arguments, Kermit-370 will prompt the
  621. user for both foreign and native filespecs (and  will  insist  on  getting  the
  622. former,  but  will do without the latter).  See the respective SEND and RECEIVE
  623. subcommands for a description of the each filespec.
  624.  
  625.  
  626.                               THE GIVE SUBCOMMAND
  627.  
  628. Syntax: GIVE table-name filespec
  629.  
  630. This compares the named translation table with its current default  values  and
  631. saves  the differences in the form of a TAKE file consisting of SET subcommands
  632. that would convert the default into  the  current  arrangement.    ATOE,  ETOA,
  633. TATOE,  and  TETOA  are  the available tables.  The details of the filespec are
  634. system-dependent, but those details will, in general, be the same  as  for  the
  635. TAKE  subcommand  (q.v.).    In  the  case of tables ATOE and ETOA, the current
  636. defaults are the values from the most recent character-set definition, if  any,
  637. but  the defaults for TATOE and TETOA always remain at the initial values.  See
  638. the SET FILE CHARACTER-SET and SET TRANSFER CHARACTER-SET subcommands for  more
  639. details.
  640.  
  641.  
  642.                              THE HINTS SUBCOMMAND
  643.  
  644. Syntax: HINTS
  645.  
  646. This  subcommand  produces a screenful of suggestions for Kermit operation, in-
  647. cluding warnings about any current settings that may be undesirable.
  648.  
  649.  
  650.                               THE HOST SUBCOMMAND
  651.  
  652. Syntax: HOST text of command
  653.  
  654. This issues a command to the host operating system from  Kermit-370.    When  a
  655. command  returns  a  non-zero  completion  code,  the  code  will be displayed.
  656. Generally, the name of the system (e.g., CMS) is treated as a synonym  for  the
  657. HOST subcommand.
  658.  
  659. When  Kermit-370  is  in (non-local) server mode, you must avoid sending it any
  660. HOST commands that trigger full-screen terminal I/O,  since  the  server-client
  661. interface   does  not  provide  any  full-screen  terminal  emulation,  nor  is
  662. Kermit-370 usually able to intercept such I/O in any case.
  663.                              THE KERMIT SUBCOMMAND
  664.  
  665. Syntax: KERMIT text of subcommand
  666.  
  667. This is provided for redundancy as the  counterpart  of  the  HOST  subcommand.
  668. Kermit-370  executes  the  specified text as a Kermit subcommand just as if the
  669. LOCAL prefix had been entered.  Note, however, that the specified text must not
  670. begin with a second KERMIT prefix.
  671.  
  672.  
  673.                             THE RECEIVE SUBCOMMAND
  674.  
  675. Syntax: RECEIVE [filespec]
  676.  
  677. The  RECEIVE  subcommand  tells Kermit-370 to accept a file or file group.  The
  678. user must issue the corresponding SEND subcommand to the other  Kermit.    When
  679. files are received, their names are recorded in a transaction log in memory and
  680. may be viewed later via the TDUMP NAMES subcommand.  The log contains the names
  681. along with the file sizes and any relevant error messages.  Another form of log
  682. may be provided through an accounting exit routine, which is called at the  end
  683. of  every RECEIVE session.  Such an accounting log may contain elapsed time and
  684. numbers of bytes sent, received, and transferred to/from disk.  If an error oc-
  685. curs  during the file transfer, as much of the file as was received is saved on
  686. disk.  If, however, the sending of a file is  cancelled  by  the  user  of  the
  687. foreign  system, Kermit-370 will discard whatever had arrived, unless FILE COL-
  688. LISION is APPEND or INCOMPLETE is KEEP.
  689.  
  690. Kermit-370 has a context-dependent maximum record length, and received  records
  691. longer  than  that  will be folded or truncated to the proper length; when this
  692. happens, Kermit may or  may  not  stop,  depending  on  the  FILE  subparameter
  693. LONGLINE.   If truncation does occur, Kermit will later note the fact as an er-
  694. ror (unless something more serious happens in the meantime).  In addition, when
  695. a  fixed record length is specified, received records are padded to the correct
  696. length.  The padding character is a blank for text files and a null for  binary
  697. files.    Received  binary  (but not V-binary or D-binary) files are treated as
  698. byte streams and broken up into records all of the logical record length, i.e.,
  699. folded.    For more details on the RECEIVE subcommand syntax and operation, see
  700. the chapter on the desired system-specific variant  of  Kermit-370  under  both
  701. RECEIVE and SET FILE.  See also (in this chapter) the SET FILE LONGLINE subcom-
  702. mand for details on record truncation and folding.
  703.  
  704.  
  705.                               THE SEND SUBCOMMAND
  706.  
  707. Syntax: SEND [filespec[<options>] [foreign-filespec]][, ...]
  708.  
  709. The SEND subcommand tells Kermit-370 to send a file or file group to the  other
  710. (foreign)  Kermit.  If no such file exists, Kermit-370 simply displays an error
  711. message and issues another prompt.  Like RECEIVE, SEND keeps a transaction  log
  712. of  all  files  transferred in a group and calls the accounting exit routine at
  713. the end of the session.  If this subcommand is issued  without  any  arguments,
  714. Kermit-370 will prompt the user for both native and foreign filespecs (and will
  715. insist on getting the former, but will do without the latter).  Either with  or
  716. without  prompting,  SEND  allows  specifying a list of up to 13 files (or file
  717. groups) separated by commas.    (By  ending  the  command  line  or  subsequent
  718. response  with  a  comma, the user ensures further prompting.)  In this syntax,
  719. the options enclosed in angle brackets may be regarded as part  of  the  native
  720. filespec.  There must be no intervening blanks.  At present, the only supported
  721. option is a range of line numbers within the file to be sent.  The range  takes
  722. the  form  [n][-[m]], where n is the number of the first line to send (counting
  723. from 1), and m is the last.  Omitting either number implies  the  corresponding
  724. limit  is  the  physical beginning or end of the file.  This same option syntax
  725. may be used in some commands issued to the foreign Kermit,  namely,  those  in-
  726. volving filespecs in 370 form.  In particular, GET and REMOTE TYPE can use this
  727. syntax.  Note that a trailing ">" is  used  by  some  other  Kermits,  such  as
  728. MS-Kermit,  to indicate redirection of the output from REMOTE commands to disk.
  729. In order to transmit the ">" and also prevent the redirection to disk, it would
  730. be necessary to add an explicit redirection to the terminal, as in
  731.  
  732.     REM TYPE filespec<n-m> > CON
  733.  
  734. Although  file  transfers  cannot be cancelled from the 370 side, Kermit-370 is
  735. capable of responding to "cancel file" or "cancel batch" signals from the local
  736. Kermit; these are typically entered by typing CTRL-X or CTRL-Z, respectively.
  737.  
  738. When Kermit-370 sends files using long packets (longer than 94), the throughput
  739. is especially sensitive to the level of noise on the line because  retries  are
  740. so  time-consuming.    Therefore,  Kermit-370  imposes an extra, heuristic size
  741. limit on packets when retries have been found necessary.    When  that  is  the
  742. case,  after  every  15  packets,  Kermit  computes the packet size for maximum
  743. throughput  assuming  that  the  transmission  errors  were  due   to   sparse,
  744. Poisson-distributed  noise bursts.  The result of this calculation is then used
  745. as another limit on the size of outgoing packets besides the one  specified  by
  746. the other Kermit.  If no retries are required, then Kermit-370 assumes the line
  747. to be noiseless and sends packets of the maximum length the  other  Kermit  al-
  748. lows.   The algorithm is explained in Kermit News V. 3 #1.  For more details on
  749. the SEND subcommand syntax and  operation,  see  the  chapter  on  the  desired
  750. system-specific variant of Kermit-370.
  751.  
  752.  
  753.                              THE SERVER SUBCOMMAND
  754.  
  755. Kermit-370  is  capable  of acting as a server.  In server mode, Kermit-370 can
  756. send and receive files, execute host commands, execute a restricted set of Ker-
  757. mit  subcommands,  and perform a variety of generic Kermit functions.  The fol-
  758. lowing list shows the typical local Kermit commands along with the server func-
  759. tions  they  elicit.    When Kermit-370 is talking to another Kermit running in
  760. server mode, these same subcommands may be used in the other direction.
  761. BYE                 log out the Kermit server.
  762. FINISH              server mode.
  763. GET                 a file or files from the server.
  764. REMOTE
  765.   COPY              a file or files.
  766.   CWD               set new working directory.
  767.   DELETE            a file or files.
  768.   DIRECTORY         display file attributes.
  769.   HELP              display a command summary, such as this.
  770.   HOST              execute a system command.
  771.   KERMIT            execute a Kermit-370 subcommand.
  772.   PRINT             send a file to be printed by the server.
  773.   RENAME            a file or files.
  774.   SPACE             display disk space.
  775.   TYPE              a file.
  776. SEND                a file or files to the server.
  777.  
  778. If your local Kermit does not support the REMOTE KERMIT command, you  may  need
  779. to  issue  SET  subcommands  to select various options before typing the SERVER
  780. subcommand.  Once in server mode, Kermit-370 will await  all  further  instruc-
  781. tions  from the client Kermit on the other end of the connection until a FINISH
  782. or BYE command is given.
  783.  
  784. Command execution in server mode is different  in  some  respects  from  normal
  785. operation.  First of all, some Kermit subcommands are not allowed (see the list
  786. at the beginning of this section).  Moreover, command errors  always  terminate
  787. any  active  TAKE file.  Also, all commands will be run in the special environ-
  788. ment that Kermit sets up during protocol transfers.  Among other things, Kermit
  789. intercepts  all  terminal  I/O  (if  possible)  in this environment in order to
  790. transmit the data to the local Kermit as text packets.
  791.  
  792. Note that some operations can be requested by several different commands.    If
  793. for  example,  the  IBM 370 system has a command "PRT" for displaying a file, a
  794. user interacting with a Kermit-370 server can choose to display a file  by  is-
  795. suing  any  of  the commands: REMOTE TYPE, REMOTE HOST PRT, REMOTE KERMIT TYPE,
  796. REMOTE KERMIT HOST PRT, or (if SYSCMD has been set ON) REMOTE KERMIT PRT.   The
  797. first  form  simply transfers the requested file as text, but the others invoke
  798. the "PRT" command with any specified options, intercept  the  terminal  output,
  799. and  return  the  results  to the local Kermit.  The first form is also distin-
  800. guished by the fact that the line range may be specified in the same manner  as
  801. in the SEND subcommand.  The syntax of the others is system-dependent.
  802.  
  803.  
  804.                               THE SET SUBCOMMAND
  805.  
  806. Syntax: SET parameter [value]
  807.  
  808. The  SET subcommand establishes or modifies various parameters controlling file
  809. transfers.  The values can, in turn, be  examined  with  the  SHOW  subcommand.
  810. Some  parameters  have two levels.  In particular, there are two matching lists
  811. of SEND and RECEIVE sub-parameters corresponding to  the  values  exchanged  by
  812. Kermits  in  the  Send-Init/ACK sequence.  For each of these SEND/RECEIVE pairs
  813. one element is encoded in outgoing parameter packets, and the other is  decoded
  814. from incoming ones.  Setting the latter by hand may be needed to establish con-
  815. tact and also has the effect of redefining the default value for decoding  from
  816. subsequent  parameter  packets.    Generally,  the distinction between SEND and
  817. RECEIVE parameters is unambiguous, the only  exception  being  TIMEOUT  (q.v.).
  818. The following SET subcommands are available in Kermit-370:
  819. ATOE                Modify the Kermit-370 ASCII-to-EBCDIC table.
  820. ATTRIBUTE           Determine A-packet generation.
  821. BLOCK-CHECK         Level of error checking for file transfer.
  822. CONTROLLER          Indicate type of terminal connection.
  823. DEBUG               Log packet traffic during file transfer.
  824. DELAY               Length of pause before a SEND subcommand.
  825. EOF                 Text file truncation at CTRL-Z.
  826. ETOA                Modify the Kermit-370 EBCDIC-to-ASCII table.
  827. FILE                Attributes for incoming or outgoing files...
  828.   CHARACTER-SET     ... for 370 storage.
  829.   COLLISION         ... treatment for duplicate names.
  830.   LONGLINE          ... treatment of too-long records.
  831.   OVERWRITE         ... treatment of attributes.
  832.   TYPE              ... text or binary.
  833.   other             ... system-specific attributes.
  834. FOREIGN             Strings added to outgoing filespec...
  835.   PREFIX
  836.   SUFFIX
  837. INCOMPLETE          Determine the action on an aborted file transfer.
  838. LINE                Specify alternate communication line.
  839. MARGIN              for sending files...
  840.   LEFT
  841.   RIGHT
  842. PROMPT              For Kermit-370 subcommands.
  843. RETRY               Maximum retry count...
  844.   INIT              ... for initial packet exchange.
  845.   PACKET            ... per packet for ongoing transfer.
  846. SERVER-TIMEOUT      Spacing between server NAK's.
  847. SPEED               Line speed for packet-size calculations.
  848. SYSCMD              Try apparently invalid Kermit subcommands on host system.
  849. TABS-EXPAND         Determine tab-to-space conversion on reception.
  850. TAKE
  851.   ECHO              Echo subcommands read from TAKE files.
  852.   ERROR-ACTION      Exit from TAKE file on command error.
  853. TEST                Facilitate testing of Kermit.
  854. TATOE               Modify the Kermit-370 ASCII-to-EBCDIC table.
  855. TETOA               Modify the Kermit-370 EBCDIC-to-ASCII table.
  856. TRANSFER            Options...
  857.   CHARACTER-SET     ... for transmission.
  858. TTABLE              Determine which tables undo the terminal translation.
  859. 8-BIT-QUOTE         Determine state of 8th-bit prefixing.
  860. SEND or RECEIVE
  861.   END-OF-LINE       Packet terminator.
  862.   PACKET-SIZE       Maximum packet size.
  863.   PAD-CHAR          Character to insert before each packet.
  864.   PADDING           Number of pad characters to insert.
  865.   PARITY            Indicate if 7-bit or 8-bit data.
  866.   QUOTE             Use to quote control characters in packets.
  867.   START-OF-PACKET   Packet beginning marker.
  868.   TIMEOUT           Time limit for response.
  869.  
  870.  
  871. SET ATOE etc.
  872.  
  873. Syntax: SET table [num1 num2]
  874.  
  875. This  modifies  one  of  the ASCII/EBCDIC translation tables used by Kermit-370
  876. (for example, to conform to your system).  The  valid  table  names  are  ATOE,
  877. ETOA, TATOE, and TETOA.  The arguments are, respectively, the offset within the
  878. named table and the new value for that offset.  If the arguments  are  omitted,
  879. the table is restored to its initial arrangement.  Both num1 and num2 should be
  880. in the range 0-255 (decimal).  For example, in ATOE or TATOE, the offset is the
  881. ASCII  character  code,  and  the new value is the new EBCDIC result code.  In-
  882. itially, ATOE and TATOE each contain two identical copies of  the  7-bit  ASCII
  883. character  table.    Helpful  hint: if you have files that make use of extended
  884. (8-bit) ASCII codes and wish to upload them via Kermit-370, be sure  to  define
  885. unique  EBCDIC  equivalents  of  all the needed 8-bit ASCII codes or else treat
  886. such files as binary data.  Any time you use the SET ATOE or SET  ETOA  subcom-
  887. mands,  that has a side effect equivalent to SET ATTRIBUTE ENCODING OFF (q.v.).
  888. If the extended ASCII character set is one of those supported for file transfer
  889. in Kermit-370, you need only issue a SET TRANSFER CHARACTER-SET (q.v.).
  890.  
  891. Note:  the  meaning of the tables depends on the TTABLE setting -- if TTABLE is
  892. OFF, the TATOE and TETOA tables are not used.
  893.  
  894.  
  895. SET ATTRIBUTE
  896.  
  897. Syntax: SET ATTRIBUTE [attribute] ON or OFF
  898.  
  899. The individual attributes are  LENGTH,  TYPE,  DATE,  CREATOR,  ACCOUNT,  AREA,
  900. PASSWORD,  BLOCKSIZE,  ACCESS,  ENCODING, DISPOSITION, PROTECT, ORIGIN, FORMAT,
  901. SYS-INFO, and BYTE-LENGTH.  Kermit-370 distinguishes between the two  forms  of
  902. this subcommand by counting "words".  In order to see the list of supported at-
  903. tributes, you must enter "SET ATTR ? ?"; if you enter just "SET ATTR ?", Kermit
  904. will list just the alternatives ON and OFF.
  905.  
  906. ON      The  specified  attribute  is to be processed, or attribute packets are
  907.         generated for all outgoing files, provided the other  Kermit  indicates
  908.         the ability to accept them.  (Default).
  909.  
  910. OFF     The  specified  attribute  is  to  be ignored and not generated, or at-
  911.         tribute packets are never generated.
  912.  
  913.  
  914. SET BLOCK-CHECK
  915.  
  916. Syntax: SET BLOCK-CHECK number
  917.  
  918. This determines the type of block check used during file transfer, provided the
  919. other  Kermit  agrees.    Valid  options for number are: 1 (for a one-character
  920. checksum), 2 (for a two-character checksum) and 3 (for a three-character  CRC).
  921. This  is one of only two Send-Init parameters that cannot be SET separately for
  922. SEND and RECEIVE.
  923.  
  924.  
  925. SET CONTROLLER
  926.  
  927. Syntax: SET CONTROLLER type
  928.  
  929. The type may be TTY, SERIES1, GRAPHICS,  AEA,  FULLSCREEN,  VTAMTTY,  or  NONE.
  930. Kermit-370  automatically  determines  whether you are connected via a Series/1
  931. (or similar) emulation controller or a TTY line.  In some  circumstances,  such
  932. as when the connection is through a non-graphics-capable 3174 port, Kermit will
  933. set CONTROLLER to NONE, which has the effect of disabling file transfers.  This
  934. subcommand is provided, though, to allow the automatic choice to be superseded,
  935. and because Kermit may not be able to  distinguish  between  Series/1-type  and
  936. other  3270-emulation  controllers.   In particular, there is no way to distin-
  937. guish between FULLSCREEN and GRAPHICS from within Kermit.  When  CONTROLLER  is
  938. set  to SERIES1, GRAPHICS, or AEA, Kermit disables the 3270 protocol conversion
  939. function by putting the terminal controller into "transparent mode", which  al-
  940. lows Kermit packets to pass through intact.  Note: an incorrect CONTROLLER set-
  941. ting may lock up or wipe out your session when you try to transfer files.
  942.  
  943. Kermit operation is possible through an IBM 3708  front  end,  but  only  in  a
  944. rather  specific configuration.  See the installation guide for your variant of
  945. Kermit-370 for the details of that and other hardware-related restrictions  and
  946. configurations.
  947.  
  948.  
  949. SET DEBUG
  950.  
  951. Syntax: SET DEBUG OFF or ON [RAW] [I/O] [SAVE] [LONG]
  952.  
  953. Note:  any  combination,  in  any  order,  of  RAW, I/O, and SAVE may follow or
  954. replace ON.  Each of the three implies ON.
  955.  
  956. ON      Keep a journal of all packets sent and received in a log file on  disk.
  957.         If the file already exists, it is erased and overwritten.  The filespec
  958.         of the log is, of course, system-dependent.  All packets are logged  in
  959.         EBCDIC  for  legibility,  even  when  CONTROLLER  is  set  to  SERIES1,
  960.         GRAPHICS, or AEA.
  961.  
  962. RAW     The same as ON, but packets are logged in the form that is passed to or
  963.         from  the  operating system, i.e., EBCDIC for TTY or VTAMTTY terminals,
  964.         and ASCII for SERIES1, GRAPHICS, and AEA terminals.
  965.  
  966. I/O     The same as ON, but the log includes additional transmission status in-
  967.         formation, such as the AID returned by a full-screen device.  See below
  968.         for a summary of the log formats.
  969.  
  970. SAVE    The same as ON, but the log file is closed after each entry  is  added,
  971.         so  that, if the session is abnormally terminated, the log file will be
  972.         complete and readable.
  973.  
  974. LONG    The same as I/O, but the additional information is not truncated to  36
  975.         bytes.
  976.  
  977. OFF     Stop logging packets and close the the log file.  (Default.)
  978.  
  979. Often,  problems  with  Kermit  file transfers or server-mode operations can be
  980. diagnosed by setting DEBUG on in one or both Kermits, regardless of  where  the
  981. problems  actually  lie.  For Kermit-370, the maximum amount of information can
  982. generally be obtained by setting DEBUG to I/O or LONG, but the  format  of  the
  983. log  depends  somewhat  on which variant of Kermit-370 is involved.  Before ex-
  984. amining the log, you should set DEBUG OFF either explicitly or by exiting  from
  985. Kermit-370.
  986.  
  987. There  is  an  optional feature for logging dumps of storage blocks at selected
  988. points in the execution.  By default, this feature  is  disabled  (at  assembly
  989. time) by having the variable symbol &KTRACE set to NO and also by virtue of the
  990. fact that no calls to the dump routine are present in  the  distribution  code.
  991. Further, the dumps are suppressed unless both DEBUG and TEST (q.v.) are set on.
  992. To select when and what blocks to dump, it is  necessary  to  insert  calls  to
  993. KHDMP  at  appropriate  points in the source before assembling.  Each such call
  994. generates a dump each time it is executed, provided that  DEBUG  and  TEST  are
  995. set,  and  the contents of all registers are preserved.  The call specifies the
  996. starting address, the length, and a short title for  the  block.    Only  eight
  997. characters of the title will be used.  Some examples:
  998.  
  999.             KHDMP ATOE+128,128,'ATOEhigh'
  1000.                           Dump the 2nd half of the ATOE table.
  1001.  
  1002.             KHDMP KHDSAV,20,'R14 - R2'
  1003.                           Dump registers 14-2.
  1004.  
  1005.             KHDMP 32(,13),40,'**R3-R12'
  1006.                           Dump registers 3-12.
  1007.  
  1008.             KHDMP (3),(0),'**QBLOCK'
  1009.                           Dump  block  addressed by R3 with length specified in
  1010.                           R0.
  1011.  
  1012. There is another debugging facility that is  enabled  by  the  variable  symbol
  1013. &KTRACE  along  with  the  dump option, namely, an execution trace.  There is a
  1014. circular buffer of trace elements in Kermit's working storage, and a  new  ele-
  1015. ment  is  written each time a Kermit subroutine is called or returns.  The ele-
  1016. ments contain the subroutine name plus (on entry) a  sequence  number  and  the
  1017. contents  of  registers 0 and 1 or (on exit) the character ">" and the contents
  1018. of registers 15 and 1.  There is also a mechanism for tracing extra  events  by
  1019. inserting KTRACE calls into the source.  For example,
  1020.  
  1021.             KTRACE 0(5),REGS=5
  1022.                           Trace eight bytes pointed to by R5 and R5 itself.
  1023.  
  1024.             KTRACE FOOBAR Trace eight bytes at label FOOBAR.
  1025.  
  1026.             KTRACE 'Found it',REGS=(1,7)
  1027.                           Trace 'Found it', R1, and R7.
  1028.  
  1029. The  trace  table is simply updated in storage, eating its own tail.  It can be
  1030. found in a memory dump by locating the "eye-catcher" that says "KTRACE:", which
  1031. precedes the start, current, and end pointers for the table.  Usually, there is
  1032. no access to the table except in ABEND dumps and the like.   It  would  not  be
  1033. very  useful  to have a KHDMP call for the table, since each line dumped to the
  1034. debug log would cause at least four other lines in the table to be  overwritten
  1035. by the ongoing trace, thereby losing most of the desired information.
  1036.  
  1037. Each  line  in  the debug log begins with a one-letter tag and a colon and con-
  1038. tains information according to the tag.  The following tags are defined.
  1039.  
  1040. S:  The text of a packet sent.  Normally, it will be encoded in EBCDIC for con-
  1041.     venience,  but  if  DEBUG  is set to RAW, the packet will appear exactly as
  1042.     passed to or from the system, i.e., in EBCDIC for TTY or VTAMTTY lines  and
  1043.     in ASCII for full-screen lines.
  1044.  
  1045. R:  The text of a packet received.  The same encoding applies.
  1046.  
  1047. A:  The  AID  and  buffer address returned by a full-screen device along with a
  1048.     read operation (three characters in all).  The values should all be  print-
  1049.     able  EBCDIC.   This obsolete tag was used by TSO and MUSIC Kermits and ap-
  1050.     peared only when DEBUG was set to I/O.
  1051.  
  1052. *:  Data dumped by the optional KHDMP routine.
  1053.  
  1054. The following tags appear only when DEBUG is set to I/O or LONG.    All  values
  1055. are  in  hexadecimal.   The meanings differ slightly according to the operating
  1056. system.  For CMS, the I/O parameter list is a channel command; for TSO or  ROS-
  1057. COE,  the  SVC  93  (TPUT/TGET)  parameters;  for  CICS, an intermediate string
  1058. similar to channel commands.  Similarly, the status data consist of the  stored
  1059. CSW plus an attention interrupt indicator for CMS, but the return code from the
  1060. I/O operation for TSO, ROSCOE, CICS, and MUSIC.
  1061.  
  1062. a:  Channel and device status after an unexpected attention interrupt.
  1063.  
  1064. b:  I/O parameter list for recovering from a CP break-in on screen.
  1065.  
  1066. c:  I/O parameter list for resuming normal screen operation.
  1067.  
  1068. d:  Data transferred on the previously indicated I/O operation.
  1069.  
  1070. e:  Status data after an I/O command has completed with an error.
  1071.  
  1072. g:  I/O parameter list for reading from the screen buffer.
  1073.  
  1074. i:  Status data after an I/O command has completed normally.
  1075.  
  1076. m:  I/O parameter list for displaying text on the screen.
  1077.  
  1078. o:  I/O parameter list for initializing the screen for transfers.
  1079.  
  1080. r:  I/O parameter list for reading from the terminal.
  1081.  
  1082. w:  I/O parameter list for a transparent write.
  1083.  
  1084. ?:  I/O parameter list for some other operation, such as clearing the screen.
  1085.  
  1086.  
  1087. SET DELAY
  1088.  
  1089. Syntax: SET DELAY number
  1090.  
  1091. Normally, Kermit-370 waits 10 seconds after the SEND subcommand before starting
  1092. the  transfer,  but this delay may be set to any non-negative value.  Two DELAY
  1093. values have special meaning.  When DELAY is 1, the usual two-line greeting dis-
  1094. played during protocol mode is abbreviated to a short message (the default Ker-
  1095. mit prompt with three dots...), and when DELAY is 0, the greeting is suppressed
  1096. entirely,  along  with the extra one-second pause for subcommands like RECEIVE,
  1097. SERVER, REMOTE, and the like.
  1098.  
  1099.  
  1100. SET EOF
  1101.  
  1102. Syntax: SET EOF ON or OFF
  1103.  
  1104. ON      Scan each incoming TEXT file for the first occurrence of CTRL-Z and ig-
  1105.         nore  the remainder of the file (but continue decoding up to the actual
  1106.         end of the file).  BINARY files are not affected.
  1107.  
  1108. OFF     Accept incoming files in their entirety.  (Default.)
  1109.  
  1110.  
  1111. SET FILE CHARACTER-SET
  1112.  
  1113. Syntax: SET FILE CHARACTER-SET name
  1114.  
  1115. Specifies the name of the character set used in files stored  on  disk.    This
  1116. setting  may  be  superseded  by an Attribute packet of an incoming file.  Cur-
  1117. rently, the available names are  CP037,  CP273,  CP275,  CP277,  CP278,  CP280,
  1118. CP281,  CP282,  CP284,  CP285, CP290, CP297, CP424, CP500, CP838, CP870, CP871,
  1119. CP875,  CP880,  CP905,  CZECH,  DKOI,  EBCDIC,  H-EBCDIK-DASH,  and  KANJI  (or
  1120. FUJITSU-KANJI, HITACHI-KANJI, or IBM-KANJI).  The names beginning with CP refer
  1121. to IBM code pages, while DKOI is the Cyrillic standard GOST  19768-87  used  in
  1122. the USSR, CZECH is a character set sometimes used in Czechoslovakia, and EBCDIC
  1123. (the default) is the traditional de facto standard EBCDIC  character  set.    A
  1124. character  set other than the default may be required by local conventions and,
  1125. if so, should be specified in the system or user INIT files.  See Table 1-1 for
  1126. the  allowed combinations of transfer and file character sets.  Explicitly set-
  1127. ting this option has a side effect equivalent to issuing SET ATTRIBUTE ENCODING
  1128. ON (q.v.).
  1129.  
  1130. The  name  KANJI  is actually just an alias for the local preferred proprietary
  1131. Kanji code (Fujitsu, Hitachi, or IBM).  The various Kanji character  sets  have
  1132. two-byte  codes  (DBCS),  but are used with one-byte code pages (SBCS) as well.
  1133. It is normally necessary to issue two SET FILE CHARACTER-SET SUBCOMMANDS in or-
  1134. der  to  set  up  for  a DBCS: first, selecting a compatible SBCS, and, second,
  1135. selecting the DBCS itself.  If  the  current  SBCS  is  incompatible  with  the
  1136. selected  DBCS,  a default will be chosen.  This default, along with the choice
  1137. of the particular proprietary character set associated with the alias KANJI, is
  1138. chosen by the installer.
  1139.  
  1140.  
  1141. SET FILE COLLISION
  1142.  
  1143. Syntax: SET FILE COLLISION action
  1144.  
  1145. Specifies  the action to take when an incoming file has the same name as an ex-
  1146. isting one.  Two of the options involve choosing an  alternative,  unique  name
  1147. similar   to   the   one   in   conflict,  but  the  details  of  choosing  are
  1148. system-specific.  Typically, the method involves adding digits to the  existing
  1149. name.
  1150.  
  1151. APPEND       The  new file is appended to the old one.  This option has the the
  1152.              same effect as the old subcommand SET APPEND ON.
  1153.  
  1154. BACKUP       The existing file is renamed,  and  the  new  file  is  given  the
  1155.              desired name as if no conflict had occurred.
  1156.  
  1157. DISCARD      The incoming file is rejected by returning a "cancel file" indica-
  1158.              tion on any Data packets.
  1159.  
  1160. OVERWRITE    The existing file is overwritten with the incoming file.  This  is
  1161.              the  default for the CMS, TSO, ROSCOE, and MUSIC variants.  Chang-
  1162.              ing this default is a good candidate for INIT files.    When  COL-
  1163.              LISION  is  set  to  OVERWRITE, the attributes of the new file are
  1164.              determined by the current setting of FILE OVERWRITE (q.v.).
  1165.  
  1166. RENAME       The incoming file is renamed so as not to destroy (overwrite)  the
  1167.              pre-existing one, and the new name is returned to the sending Ker-
  1168.              mit for information purposes.  This has the same effect as the old
  1169.              subcommand  SET  WARNING  ON.    This  is the default for the CICS
  1170.              variant.
  1171.  
  1172.  
  1173. SET FILE LONGLINE
  1174.  
  1175. Syntax: SET FILE LONGLINE FOLD or TRUNCATE or HALT
  1176.  
  1177. This specifies the action to take when a received line is longer than the  cur-
  1178. rent  maximum  record  length.    That length is determined by the context in a
  1179. system-specific way.  Refer to the description of the RECEIVE subcommand in the
  1180. appropriate chapter for details.
  1181.  
  1182. FOLD       Specifies  that  long lines are to be split into two or more records
  1183.            as needed, all but the last being of the maximum length.    No  null
  1184.            records  are  created when the received line is an exact multiple of
  1185.            the record length.  BINARY files are,  by  definition,  always  con-
  1186.            sidered  as a single line and, therefore, are always folded, regard-
  1187.            less of the setting of this parameter.  V-BINARY and D-BINARY files,
  1188.            on the other hand, are reconstructed by folding at points determined
  1189.            by the context within the received file, and cannot be  folded  fur-
  1190.            ther  to  fit the current maximum length.  Any such records that are
  1191.            too long will be truncated.
  1192.  
  1193. TRUNCATE   Specifies that long lines are to be truncated at the maximum length.
  1194.            (Default.)   Kermit-370 takes note of the number of such truncations
  1195.            performed on a file and reports it in the STATUS  message  and  also
  1196.            treats  the fact of truncation as an error when the file transfer is
  1197.            complete.  The file will have been transferred,  but  obviously  not
  1198.            quite  intact.    However, this option can be useful for some tasks,
  1199.            such as stripping sequence numbers from card images.  The process is
  1200.            similar  to  that  provided  by  the SET MARGIN RIGHT subcommand for
  1201.            sending files.
  1202.  
  1203. HALT       Specifies that a file transfer is to halt immediately if a  received
  1204.            line  is too long.  Kermit-370 then issues an error packet and stops
  1205.            the transfer.
  1206.  
  1207.  
  1208. SET FILE OVERWRITE
  1209.  
  1210. Syntax: SET FILE OVERWRITE DEFAULT or PRESERVE
  1211.  
  1212. DEFAULT    Specifies that the current file attribute settings are  to  be  used
  1213.            for  the  new  file.    The result is roughly the same as if the old
  1214.            file, if  any,  were  completely  erased  before  the  new  file  is
  1215.            received.  (Default.)
  1216.  
  1217. PRESERVE   Specifies  that  the attributes of the file being overwritten are to
  1218.            be retained and used for the new file.  The result  is  roughly  the
  1219.            same  as  if  the  old files contents were deleted, and the new file
  1220.            were appended to the empty stub.
  1221.  
  1222.  
  1223. SET FILE TYPE
  1224.  
  1225. Syntax: SET FILE TYPE type
  1226.  
  1227. Specifies the type of data comprising files to be sent or received.  This  set-
  1228. ting  may  be  temporarily superseded by the Attribute packets for a file being
  1229. received.
  1230.  
  1231. TEXT       Specifies ordinary text.  ASCII-to-EBCDIC or EBCDIC-to-ASCII  trans-
  1232.            lation  is  performed on the data.  Trailing blanks are removed, and
  1233.            CRLF's are appended to outgoing records. CRLF's are used,  in  turn,
  1234.            to  determine  the  end  of  incoming records, which are padded with
  1235.            blanks if necessary to fill buffers.   (Default.)    Note:  trailing
  1236.            blanks  are  removed  from  outgoing, varying-length records only if
  1237.            they consist of a single blank each, or if there is a  right  margin
  1238.            specified  (q.v.).    Further  note:  a  given file is intrinsically
  1239.            categorized as fixed-length or varying-length (or  undefined-length)
  1240.            by  the file system and cannot be changed simply by setting the FILE
  1241.            RECFM  parameter  in  Kermit.    Conversion  between  formats  is  a
  1242.            system-specific  function;  see  the system documentation or consult
  1243.            your local support staff for details on conversion techniques.
  1244.  
  1245. BINARY     Specifies bit-stream data.  No translation is performed,  no  CRLF's
  1246.            are  added  to  outgoing  records,  and blanks are neither added nor
  1247.            removed.  Incoming bytes  are  added  successively  to  the  current
  1248.            record  buffer,  which  is  written  out  when  the current LRECL is
  1249.            reached.  Padding, if necessary, is done with nulls.
  1250.  
  1251. V-BINARY   Specifies varying-length-record binary data.  This type is like  BI-
  1252.            NARY, except that a two-byte binary prefix is added to each outgoing
  1253.            record giving the number of data bytes, and incoming records are set
  1254.            off by (and stripped of) their prefixes on receipt.
  1255.  
  1256. D-BINARY   Is  like  V-BINARY  except  that  the  length prefixes are five-byte
  1257.            ASCII-encoded decimal (right-justified with leading zeroes).
  1258. SET FOREIGN
  1259.  
  1260. Syntax: SET FOREIGN PREFIX string
  1261.  
  1262. This defines a prefix string to be added to the outgoing filespec generated  by
  1263. the  SEND  subcommand.  For example, the string might be set to "B:" to specify
  1264. output to the B disk drive on the other Kermit's system.  The default is a null
  1265. string.  There is also a FOREIGN SUFFIX handled in the same manner.
  1266.  
  1267.  
  1268. SET HANDSHAKE
  1269.  
  1270. Syntax: SET HANDSHAKE number
  1271.  
  1272. This defines the character, if any, that Kermit-370 should send (or cause to be
  1273. sent) immediately before reading each packet.  The character is  given  as  the
  1274. decimal  of  an  ASCII  control  character, or as zero if no handshake is to be
  1275. sent.  The default is 17 (XON), and any value in the range 0-31 is  valid,  but
  1276. 13 (CR) should not be used because it is generally the end-of-packet character.
  1277. When Kermit-370  is  running  through  a  full-duplex  connection  (such  as  a
  1278. "SERIES1"),  the  traditional  IBM  handshaking is not necessary, and HANDSHAKE
  1279. should be set to 0 (as long as the other Kermit can be instructed not to expect
  1280. a  handshake).  Note the distinction between SET HANDSHAKE in Kermit-370 (where
  1281. it defines a character to be sent) and in many micro Kermits (where it  defines
  1282. a character to be expected).
  1283.  
  1284.  
  1285. SET INCOMPLETE
  1286.  
  1287. Syntax: SET INCOMPLETE DISCARD or KEEP
  1288.  
  1289. DISCARD   Specifies that incomplete files (that is, files partially received in
  1290.           a transfer cancelled by the other Kermit) are to be erased.  This  is
  1291.           the  default.    Note  that when FILE COLLISION is APPEND, incomplete
  1292.           files are never erased, lest pre-existing data be lost.
  1293.  
  1294. KEEP      Specifies that incomplete files are to be kept.
  1295.  
  1296.  
  1297. SET LINE
  1298.  
  1299. Syntax: SET LINE [name]
  1300.  
  1301. This specifies an alternate communication line for file transfers.  If the name
  1302. is omitted, the default line (the user's terminal) is used.  The format of name
  1303. is, of course, system-dependent, and some variants of Kermit-370 do not support
  1304. any alternate lines.  No variant currently allows Kermit-370 to CONNECT over an
  1305. alternate line.
  1306.  
  1307.  
  1308. SET MARGIN
  1309.  
  1310. Syntax: SET MARGIN side column
  1311.  
  1312. When Kermit-370 sends a text file, each line may be truncated on  the  left  or
  1313. right (or both) at fixed column numbers.  Only the text from the left margin to
  1314. the right margin (inclusive) will be sent, and any trailing blanks in the trun-
  1315. cated lines will be stripped.  A value of zero for either margin disables trun-
  1316. cation on that side.
  1317.  
  1318.  
  1319. SET PROMPT
  1320.  
  1321. Syntax: SET PROMPT [string]
  1322.  
  1323. This defines the character string that Kermit-370 displays when  asking  for  a
  1324. subcommand.   The prompt may be any string of up to 20 characters.  The default
  1325. is the name of the system-specific variant of  Kermit-370  followed  by  a  ">"
  1326. sign,  e.g.,  Kermit-CMS>.    If the string is omitted, normal system prompting
  1327. will occur.
  1328.  
  1329.  
  1330. SET RETRY
  1331.  
  1332. Syntax: SET RETRY INITIAL or PACKETS number
  1333.  
  1334. Kermit-370 resends its last packet after receiving a NAK or bad packet, but  it
  1335. eventually  gives  up after repeated failures on the same packet.  The limit on
  1336. retries can be set separately for the initial  packet  exchange  (Send-Init  or
  1337. server-mode  command)  and for ordinary packets.  The default for INITIAL is 16
  1338. and for PACKETS, 5.  Either limit can be set to any positive value.
  1339.  
  1340.  
  1341. SET SERVER-TIMEOUT
  1342.  
  1343. Syntax: SET SERVER-TIMEOUT time
  1344.  
  1345. This defines the time in seconds that Kermit-370 in server mode should wait for
  1346. a command before sending a NAK packet.  The default is 120.  A value of 0 means
  1347. that Kermit should wait indefinitely, not only in the server loop, but  in  all
  1348. transfers, regardless of the timeout value specified by the other Kermit.  Some
  1349. variants are unable to time out in any  case.    Also,  timeouts  are  not  im-
  1350. plemented for any of the full-screen terminal controllers.
  1351.  
  1352.  
  1353. SET SPEED
  1354.  
  1355. Syntax: SET SPEED number
  1356.  
  1357. This determines the communication line speed assumed by Kermit-370 in calculat-
  1358. ing the optimum packet size.  If the value is zero, such calculations are  sup-
  1359. pressed.    This  option is purely informative and has no effect on actual line
  1360. speed.  (Default 1200.)
  1361.  
  1362.  
  1363. SET SYSCMD
  1364.  
  1365. Syntax: SET SYSCMD ON or OFF
  1366.  
  1367. ON      If the user enters a command string which is not a valid Kermit subcom-
  1368.         mand,  Kermit-370 will pass the string along to the host operating sys-
  1369.         tem for execution.  If the string is rejected by the  system  as  well,
  1370.         Kermit will report it as an invalid Kermit subcommand.  Otherwise, Ker-
  1371.         mit will assume the string was intended as  a  host  command  and  will
  1372.         simply report the completion code if non-zero.
  1373.  
  1374. OFF     Invalid  Kermit  subcommands  are simply rejected as such.  System com-
  1375.         mands may be executed, of course, but only by  specifying  the  generic
  1376.         prefix "HOST" or the appropriate system-specific prefix, such as CMS or
  1377.         TSO.  (Default.)
  1378.  
  1379.  
  1380. SET TABS-EXPAND
  1381.  
  1382. Syntax: SET TABS-EXPAND ON [list] or OFF
  1383.  
  1384. ON      Tab characters in incoming TEXT files  are  replaced  by  one  or  more
  1385.         blanks to bring the record size up to the next higher multiple of eight
  1386.         for each tab.  If tab settings other than columns 1, 9,  17,  etc.  are
  1387.         desired,  they  may  be  specified  explicitly  in a list following the
  1388.         keyword "ON".  Items in the list may be separated by spaces  or  commas
  1389.         and must be in strictly increasing order.
  1390.  
  1391. OFF     Incoming tabs are retained.  (Default.)
  1392.  
  1393.  
  1394. SET TAKE ECHO
  1395.  
  1396. Syntax: SET TAKE ECHO ON or OFF
  1397.  
  1398. ON      Subcommands are echoed to the terminal as they are executed from a TAKE
  1399.         file.
  1400.  
  1401. OFF     Subcommands from a TAKE file are executed "silently."  (Default.)
  1402.  
  1403.  
  1404. SET TAKE ERROR-ACTION
  1405.  
  1406. Syntax: SET TAKE ERROR-ACTION CONTINUE or HALT
  1407.  
  1408. CONTINUE   Execution continues in a TAKE file regardless of  illegal  commands,
  1409.            except in server mode.  (This is the default.)
  1410.  
  1411. HALT       A  command error in a TAKE file causes immediate exit to Kermit sub-
  1412.            command level.
  1413.  
  1414.  
  1415. SET TEST
  1416.  
  1417. Syntax: SET TEST ON or OFF
  1418.  
  1419. ON      Allow setting the START-OF-PACKET and other special characters  to  any
  1420.         value, and suppress type 1 checksum testing on received packets.
  1421.  
  1422. OFF     Normal operation.  (Default.)
  1423.  
  1424.  
  1425. SET TRANSFER CHARACTER-SET
  1426.  
  1427. Syntax: SET TRANSFER CHARACTER-SET name
  1428.  
  1429. Specifies  the  name  of  the character set used in sending or receiving files.
  1430. This setting may be superseded by an Attribute  packet  of  an  incoming  file.
  1431. Currently,  the  available  names  are  ASCII  (the  default), CYRILLIC, GREEK,
  1432. HEBREW, JAPAN-EUC, KATAKANA, LATIN1, LATIN2,  LATIN3,  THAI,  and  TRANSPARENT.
  1433. There  are  also  special aliases L1, L2, and L3 for the LATINx names.  All but
  1434. JAPAN-EUC, TRANSPARENT, and ASCII represent 8-bit codes composed of a  pair  of
  1435. 94- or 96-character sets from the ISO registry combined with normal definitions
  1436. for the so-called C0 and C1 characters.  JAPAN-EUC is a DBCS for encoding Kanji
  1437. characters,  plus Roman, Greek, and Cyrillic.  ASCII is the traditional charac-
  1438. ter set supported by Kermit,  but  one  of  the  newer,  8-bit  sets  would  be
  1439. preferable  for  most  users.   This option is, therefore, a good candidate for
  1440. inclusion in the system INIT file.  See Table 1-1 for the allowed  combinations
  1441. of transfer and file character sets.  Explicitly setting this option has a side
  1442. effect equivalent to issuing SET ATTRIBUTE ENCODING ON (q.v.).   There  is  one
  1443. exception,  namely,  TRANSPARENT,  which  sets  ENCODING  OFF and replaces both
  1444. translation tables with null operations, regardless of the current nominal file
  1445. character set.
  1446.  
  1447. The  biggest  drawback of the built-in tables for the various character sets is
  1448. that neither the ISO registry nor  IBM  defines  any  mapping  between  the  C1
  1449. characters  (hex  80-9F  in ISO arrangements) and the characters of EBCDIC code
  1450. pages.  Thus, the mappings in Kermit-370 tables are somewhat arbitrary, and fu-
  1451. ture pronouncements may suddenly invalidate some or all of those 32 mappings.
  1452. SET TRANSFER LOCKING-SHIFT
  1453.  
  1454. Syntax: SET TRANSFER LOCKING-SHIFT ON or OFF or FORCED
  1455.  
  1456. ON      The Kermit locking-shift protocol is to be used in transfers to or from
  1457.         cooperating partners, provided that 8th-bit quoting is enabled.
  1458.  
  1459. OFF     The Kermit locking-shift protocol is not to be used.
  1460.  
  1461. FORCED  The Kermit locking-shift protocol is to  be  used,  regardless  of  the
  1462.         cooperation  of  the  other Kermit.  The encoding uses only the locking
  1463.         shifts, to the exclusion of 8th-bit quoting.
  1464.  
  1465.  
  1466. SET TTABLE
  1467.  
  1468. Syntax: SET TTABLE ON or OFF or KP
  1469.  
  1470. ON      The translation that undoes the terminal controller's ASCII/EBCDIC con-
  1471.         version comes from the TATOE and TETOA tables, rather than the ATOE and
  1472.         ETOA tables (which are used only for translating disk files).  This op-
  1473.         tion  has  no  effect  when there is no translation built into the con-
  1474.         troller, i.e., with SERIES1, GRAPHICS, and AEA connections.
  1475.  
  1476. OFF     The ATOE and ETOA tables are used for all translations  by  Kermit-370.
  1477.         (Default.)
  1478.  
  1479. KP      Same  as  ON, but also establishes values in the TATOE and TETOA tables
  1480.         based on IBM's corporate standard  ASCII/EBCDIC  translation  (distinct
  1481.         from the internationally accepted de facto standard).
  1482.  
  1483.  
  1484. SET 8-BIT-QUOTE
  1485.  
  1486. Syntax: SET 8-BIT-QUOTE char or ON or OFF
  1487.  
  1488. This  controls  whether eighth-bit prefixing is done and can be used to specify
  1489. the character to be used.  This is one of only two  Send-Init  parameters  that
  1490. cannot be SET separately for SEND and RECEIVE.
  1491.  
  1492. char    Eighth-bit prefixing will be done using char, provided the other Kermit
  1493.         agrees.  The default value is an ampersand.
  1494.  
  1495. ON      Eighth-bit prefixing will be done, provided the other Kermit explicitly
  1496.         requests it (and specifies the character).
  1497.  
  1498. OFF     Eighth-bit prefixing will not be done.
  1499.  
  1500.  
  1501. SET SEND/RECEIVE
  1502.  
  1503. The  following  parameters  can be set either as SEND or RECEIVE options.  As a
  1504. rule, in each pair, one is the operational value, and  the  other  is  used  to
  1505. change  the default for Send-Init packets received from the other Kermit and to
  1506. set up parameter values as if the other Kermit had specified them on  the  pre-
  1507. vious  exchange.    When both values are described, the operational one will be
  1508. first.  For all parameters besides QUOTE, the operational value is the RECEIVE.
  1509. After  a transfer, the operational values will be unchanged, but the others (as
  1510. displayed by SHOW) will reflect the parameters specified by the  other  Kermit.
  1511. The  underlying  defaults established by previous SET subcommands will still be
  1512. in effect.  In the syntax descriptions, mode is SEND or RECEIVE.
  1513.  
  1514.  
  1515. END-OF-LINE
  1516.  
  1517. Syntax: SET mode END-OF-LINE number
  1518.  
  1519. RECEIVE should not be changed.
  1520.  
  1521. SEND may be needed to establish contact.  If the other system needs packets  to
  1522. be terminated by anything other than carriage return, specify the decimal value
  1523. of the desired ASCII character.  number must be in the  range  0-31  (decimal).
  1524. The default is 13 (CR).
  1525.  
  1526.  
  1527. PACKET-SIZE
  1528.  
  1529. Syntax: SET mode PACKET-SIZE number
  1530.  
  1531. RECEIVE  defines  number as the maximum length for incoming packets.  The valid
  1532. range is 26-9024, but 94 is the limit for normal short-packet  protocol.    The
  1533. default  is 80.  Specifying a value greater than 94 is necessary and sufficient
  1534. to enable the long-packet protocol for transfers to  Kermit-370  (provided  the
  1535. other  Kermit is willing).  Kermit-370 will actually accept long packets in any
  1536. case, but the protocol requires that the other  Kermit  not  send  them  unless
  1537. Kermit-370  asks.   Raising this value from the default is a good candidate for
  1538. inclusion in INIT files.  In practice,  the  packet  size  may  be  limited  by
  1539. hardware  and programming considerations.  See the system-specific chapters for
  1540. details.
  1541.  
  1542. SEND might be needed for  sending  files  to  a  minimal  Kermit  that  neither
  1543. specifies  a  buffer  size in the Send-Init sequence nor can accept the default
  1544. (80).  It may also be used to specify the packet size for a "raw" download  via
  1545. the  XTYPE  subcommand.  This parameter has no other function and is completely
  1546. irrelevant to long packets.   If  the  other  Kermit  asks  for  long  packets,
  1547. Kermit-370 will always comply.
  1548.  
  1549.  
  1550. PAD-CHAR
  1551.  
  1552. Syntax: SET mode PAD-CHAR number
  1553.  
  1554. RECEIVE defines number as the character to be used by the other Kermit for pad-
  1555. ding packets.  The character must be an ASCII control character (in  the  range
  1556. 0-31).  The default is 0 (NULL).  This option is seldom useful.
  1557.  
  1558. SEND  may  be needed to establish contact if the other Kermit (or the transmis-
  1559. sion line) needs padded packets.
  1560.  
  1561.  
  1562. PADDING
  1563.  
  1564. Syntax: SET mode PADDING number
  1565.  
  1566. RECEIVE defines the number of pad characters to be  used  for  padding  packets
  1567. from  the other Kermit.  This number may be anywhere from 0 to 94.  The default
  1568. is 0.  This option is seldom useful.
  1569.  
  1570. SEND may be needed to establish contact if the other Kermit (or  the  transmis-
  1571. sion line) needs padded packets.
  1572.  
  1573.  
  1574. PARITY
  1575.  
  1576. Syntax: SET mode PARITY MARK or NONE
  1577.  
  1578. RECEIVE  specifies  the  parity  expected  in  the  transparent-mode ASCII data
  1579. received by the mainframe from a full-screen device.  Such data will  typically
  1580. have  either  all  Mark  parity (seven data bits with the eighth bit set) or no
  1581. parity (eight data bits).  This is typically not the same as the parity used in
  1582. communications  between  the  protocol  convertor and the terminal.  Kermit-370
  1583. must know which kind of parity  to  expect  in  order  to  calculate  checksums
  1584. properly.  Since Kermit-370 does not actually verify parity, the other possible
  1585. variants (ODD, EVEN, and SPACE) are lumped together with MARK  parity  for  the
  1586. purpose  of  this subcommand, which merely chooses between 7-bit and 8-bit data
  1587. transfer.  The default is MARK.
  1588.  
  1589. SEND is also an operational value, specifying the parity to  be  used  in  con-
  1590. structing  outgoing  data  packets on full-screen devices.  NONE is the default
  1591. and is generally preferable, in that it permits binary  transfers  without  the
  1592. need for eighth-bit prefixing, but MARK may be required in some configurations.
  1593.  
  1594.  
  1595. QUOTE
  1596.  
  1597. Syntax: SET mode QUOTE char
  1598.  
  1599. SEND indicates a printable character for prefixing (quoting) control characters
  1600. and  other prefix characters.  The only good reason to change this would be for
  1601. sending a file that contains many "#" characters (the normal control prefix) as
  1602. data.    It  must  be  a  single  character  with  ASCII  value 33-62 or 96-126
  1603. (decimal).
  1604.  
  1605. RECEIVE would be needed only for talking to  a  crippled  Kermit  that  uses  a
  1606. non-standard quoting character, but does not admit it.
  1607.  
  1608.  
  1609. START-OF-PACKET
  1610.  
  1611. Syntax: SET mode START-OF-PACKET number
  1612.  
  1613. RECEIVE  defines  number  as  the character to be expected to mark the start of
  1614. packets from the other Kermit.  The character must be an ASCII control  charac-
  1615. ter  (in the range 0-31).  The default is 1 (SOH).  This may need to be changed
  1616. to establish contact.
  1617.  
  1618. SEND may also need to be changed to establish contact.  It  defines  number  as
  1619. the character to be used to mark outgoing packets.
  1620.  
  1621.  
  1622. TIMEOUT
  1623.  
  1624. Syntax: SET mode TIMEOUT time
  1625.  
  1626. RECEIVE  defines the time in seconds the other Kermit is to wait for a response
  1627. from Kermit-370 before resending a packet.  The default is 5.   A  value  of  0
  1628. means the other Kermit should wait indefinitely.
  1629.  
  1630. SEND  may  be  needed to define the time in seconds Kermit-370 is to wait for a
  1631. response from the other Kermit in the initial  packet  exchange,  although  the
  1632. default  value  0  (indefinite wait) is probably satisfactory, especially since
  1633. Kermit-370 in many cases cannot time out anyway.  Specifying a  non-zero  value
  1634. will  prevent  the  other  Kermit from ever requesting infinite "patience" from
  1635. Kermit-370.
  1636.  
  1637.  
  1638.                               THE SHOW SUBCOMMAND
  1639.  
  1640. Syntax: SHOW [option]
  1641.  
  1642. The SHOW subcommand displays the values of all parameters that can  be  changed
  1643. with  the  SET  subcommand, except ATOE, ETOA, TATOE, and TETOA (for those, see
  1644. the TDUMP subcommand).  If specified, option can be a particular  parameter  or
  1645. the  keyword  "ALL"  (the default).  Groups of parameters, such as SEND, can be
  1646. displayed by requesting the group name, or  individual  sub-parameters  can  be
  1647. displayed by specifying the complete name.  For example,
  1648.  
  1649.     SHOW RECEIVE EOL
  1650.  
  1651. will  display  the  decimal value of the packet terminator that Kermit-370 cur-
  1652. rently expects, i.e., 13.  Similarly,
  1653.  
  1654.     SHOW FOREIGN
  1655.  
  1656. will display the character strings currently in use for prefix  and  suffix  on
  1657. each  outgoing  filespec.    When "ALL" is specified or implied, all parameters
  1658. other than the attribute switches are displayed.
  1659.  
  1660.  
  1661.                              THE STATUS SUBCOMMAND
  1662.  
  1663. Syntax: STATUS
  1664.  
  1665. This subcommand displays information about the previously executed  subcommand.
  1666. The  response  will include either the appropriate error message or the message
  1667. "No errors".  The initial status is "No file transfers yet".    If  the  status
  1668. reflects  an  error  condition,  the name of the last file used (excluding TAKE
  1669. files) will be displayed as well.  If the error was detected by the other  Ker-
  1670. mit,  the  message  will be "Micro aborted" followed by the text from the Error
  1671. packet.  Conversely, if Kermit-370 detected the error, the text of  the  status
  1672. message  will  have constituted the error packet sent out.  In any case, if the
  1673. last file transfer was cancelled (by virtue of an attribute mismatch or  manual
  1674. intervention),  the  reason  for cancellation is displayed.  Also, if the error
  1675. occurred in disk I/O, any available explanatory information is displayed.  Nor-
  1676. mally,  the  error status is altered only when a transfer-initiating subcommand
  1677. (SEND or RECEIVE) is executed, but there are several exceptions.  If an invalid
  1678. subcommand  is entered, the status becomes "Kermit command error", and the next
  1679. subcommand entered will reset the status.  Also, in server mode  every  subcom-
  1680. mand  is  received  through a transfer from the other Kermit and may affect the
  1681. status (except the STATUS subcommand itself, of course).
  1682.  
  1683. Other information is also included.  When Kermit-370 has been forced  to  trun-
  1684. cate  one or more records in the last RECEIVE operation (because of the current
  1685. maximum record length), the number of  records  truncated  is  reported.    The
  1686. status  display also includes throughput statistics for the last transfer: num-
  1687. ber of files sent, duration, number of packets, number of retries, and averages
  1688. of  bytes/packet  and  bytes/second.   These last two quantities are calculated
  1689. separately for bytes sent and received on  the  communication  line  (including
  1690. padding,  if any), and the last quantity is also calculated on the basis of the
  1691. number of bytes read from or written to disk.  Further, if retries were  neces-
  1692. sary,  Kermit-370 computes the optimum packet size assuming the retries to have
  1693. been due to sparse, Poisson-distributed bursts of noise.    This  is  the  same
  1694. heuristic   optimum  that  Kermit-370  computes  and  uses  as  an  alternative
  1695. packet-size limit when sending long packets.  If TEST is set  on,  Kermit  also
  1696. reports the maximum size attained by its storage stack since execution began.
  1697.  
  1698.  
  1699.                               THE STOP SUBCOMMAND
  1700.  
  1701. Syntax: STOP
  1702.  
  1703. This  is  not a subcommand in the usual sense.  Instead, it is a command string
  1704. that can be entered on the communication line while Kermit-370 is  in  protocol
  1705. mode  and will cause protocol mode to cease immediately.  This may be useful if
  1706. the other Kermit has crashed.  The word "stop" may be entered in  either  upper
  1707. or  lower  case,  but  it  must be the only character string in the "packet" in
  1708. question.
  1709.  
  1710.  
  1711.                               THE TAKE SUBCOMMAND
  1712.  
  1713. Syntax: TAKE filespec
  1714.  
  1715. Execute Kermit subcommands from the specified file, usually called a TAKE file.
  1716. The  TAKE  file  may in turn include TAKE subcommands, and the nesting may con-
  1717. tinue to a depth of ten.  If  a  TAKE  file  includes  the  subcommand  SERVER,
  1718. however,  the  nesting  count  is saved and starts over again in server mode in
  1719. case the client Kermit should transmit a REMOTE KERMIT TAKE command.  The  user
  1720. has  the option of seeing the subcommands echoed from the TAKE file as they are
  1721. executed and also the option of automatically exiting from a TAKE file  on  er-
  1722. ror.  See the subcommand SET TAKE for details.
  1723.  
  1724.  
  1725.                              THE TDUMP SUBCOMMAND
  1726.  
  1727. Syntax: TDUMP table-name or NAMES
  1728.  
  1729. This displays the contents of table-name.  The same table can be modified using
  1730. the SET subcommand.  The ATOE, ETOA, TATOE, and TETOA tables can  presently  be
  1731. displayed  and  changed.    The NAMES table is the transaction log for the last
  1732. transfer, consisting of the filespec of each file sent or received, along  with
  1733. the size (in Kbytes) and any error messages.
  1734.  
  1735.  
  1736.                         THE TYPE AND XTYPE SUBCOMMANDS
  1737.  
  1738. Syntax: [X]TYPE filespec
  1739.  
  1740. These  subcommands  display  the named file.  TYPE is effectively a synonym for
  1741. (and allows the same options as) the host system command for  displaying  files
  1742. at  the  terminal,  but  XTYPE performs a raw file transfer on the current com-
  1743. munication line (which need not be the terminal) according to the current  CON-
  1744. TROLLER  setting.   Thus, XTYPE uses transparent mode if CONTROLLER is SERIES1,
  1745. GRAPHICS, or AEA.  Also, it sends the data in bursts no larger than the current
  1746. SEND  PACKET-SIZE.    Since XTYPE is basically a modified SEND, the options al-
  1747. lowed on the filespec for SEND are also allowed for XTYPE.
  1748.  
  1749.  
  1750. 1.5. Before Connecting to the Mainframe
  1751.  
  1752. Several options must be set in the micro Kermit before connecting to an IBM 370
  1753. system  as  a  line-mode  device.  You should set LOCAL-ECHO to ON (to indicate
  1754. half-duplex).  This is the norm but not true in absolutely every case; if  each
  1755. character  appears  twice  on  your  terminal  screen,  set  LOCAL-ECHO to OFF.
  1756. FLOW-CONTROL should be set to NONE, and on some systems HANDSHAKE should be set
  1757. to XON.  The parity should be set according to the system's specifications.  On
  1758. some micro Kermits, all of the above is done in one step using the DO IBM macro
  1759. (or SET IBM ON).  Set the baud rate to correspond to the line speed.
  1760.  
  1761. Connecting  through  a full-screen device also requires that certain options be
  1762. set in the micro Kermit.   You  should  set  LOCAL-ECHO  to  OFF  (to  indicate
  1763. full-duplex).   FLOW-CONTROL should be set to XON/XOFF, and HANDSHAKE should be
  1764. set to OFF.  For many systems, the PARITY should be set to EVEN.  Set the  baud
  1765. rate to correspond to the line speed.
  1766.  
  1767. One  exception  to these rules is the case where the micro Kermit is attempting
  1768. automated  file  transfer,  e.g.,  downloading  several  separate  files   from
  1769. Kermit-370  running  in server mode.  In fact, under those circumstances, hand-
  1770. shaking is necessary even with "SERIES1" connections, and the two Kermits  must
  1771. be  instructed to adopt a common handshake character (e.g., by SET HANDSHAKE 10
  1772. to Kermit-370 and SET HANDSHAKE LF to the micro).
  1773.  
  1774. In any case, you should make sure that either the micro  Kermit  or  Kermit-370
  1775. will  provide  timeouts  during file transfers (if not both).  Some variants of
  1776. Kermit-370 (notably CMS) cannot provide timeouts, and you may need to  set  the
  1777. TIMER to ON in the micro.
  1778.  
  1779. When  you are connecting through a protocol convertor, it is useful to know the
  1780. key sequence that causes the screen image to be repainted from the controller's
  1781. memory.  In many cases, it is CTRL-V, although CTRL-G and CTRL-C are also some-
  1782. times used.  In general, this sequence should be typed whenever reconnecting to
  1783. Kermit-370  after being in Kermit protocol mode (and sometimes after merely es-
  1784. caping to the local Kermit), since the  local  Kermit  may  have  modified  the
  1785. screen.
  1786.  
  1787.  
  1788. 1.6. Trouble-shooting Protocol Converters
  1789.  
  1790. Many,  but not all, protocol converters have transparent modes that permit Ker-
  1791. mit file transfers.  The welter of competing and often incompatible  communica-
  1792. tions  devices  would  cause  a major headache, except for three circumstances.
  1793. First, Kermit-370 has routines for automatically detecting which kind of  front
  1794. end  is  controlling  the  current session; second, the Kermit installer is en-
  1795. couraged to tailor Kermit to force the correct choice  of  CONTROLLER  whenever
  1796. those  routines  don't  work  properly; and, third, Kermit offers a last-resort
  1797. mode of operation that will work with almost any protocol converter.    Because
  1798. of  the  limitations  in  the  catch-all mode (known as FULLSCREEN mode), it is
  1799. still best to take advantage of the transparency, if any, in the protocol  con-
  1800. verter,  and the automatic detection routines still play an important role.  It
  1801. will be instructive to outline what those routines actually do and how they can
  1802. go wrong.
  1803.  
  1804.  
  1805. Recognizing a Series/1
  1806.  
  1807. Although  protocol  converters are advertised as simulating the behavior of IBM
  1808. 3270-type terminals, there generally are differences which  could  be  used  to
  1809. distinguish  each  type  of device from the others and from real 3270-type ter-
  1810. minals.  However, all that really matters to Kermit-370 is whether there  is  a
  1811. transparent  mode  available  such  that file transfers can be carried out.  To
  1812. date, only three fundamentally different transparent modes have  been  reported
  1813. to  Columbia,  and  it seems likely that no others have been (or, perhaps, ever
  1814. will be) implemented.  All are supported by Kermit.
  1815.  
  1816. Kermit-370 recognizes these front  ends  automatically  by  making  two  simple
  1817. tests.    The  first  takes advantage of one of the advanced features first im-
  1818. plemented in the Yale ASCII system and  subsequently  copied  in  many  of  the
  1819. devices that adopted the same transparent mode.  This feature is a special 3270
  1820. data-stream order which requests a status report from the  protocol  converter.
  1821. Kermit  sends  this  order  and then reads the "3270 screen".  If Kermit sees a
  1822. valid status report, it sets CONTROLLER to SERIES1 and stops testing.
  1823.  
  1824.  
  1825. Two catches
  1826.  
  1827. Obviously, the Yale status order is not implemented  in  most  other  kinds  of
  1828. hardware.  Thus, the order would be rejected by a non-Yale-type controller, and
  1829. that could have undesirable side effects on the hardware.  However, hardware is
  1830. generally  designed  to be robust -- the real drawback lies in the side effects
  1831. on certain communications software (notably VTAM/TSO), which may respond  badly
  1832. while  trying to protect the robust hardware from illegal orders.  If it proves
  1833. impossible to make the external software behave properly, the only recourse  is
  1834. to  modify  Kermit-370  to skip the first test altogether and possibly to force
  1835. the CONTROLLER setting; this modification is described in the relevant "Beware"
  1836. file in a note dated 89/2/27.
  1837.  
  1838. Catch  Two  is  that  the status order is not implemented in all of the devices
  1839. that support Yale-ASCII-style transparent mode.  This means that  some  devices
  1840. "fall  through  the  cracks"  in this procedure.  A site where such devices are
  1841. used may find it expedient to modify Kermit (following the same  "Beware"  pat-
  1842. tern)  to  force the procedure to set CONTROLLER to SERIES1 (assuming there are
  1843. no other protocol converters also in use that support one of the  other  trans-
  1844. parent modes).  A list of such devices can be found in a footnote in the Kermit
  1845. distribution file ik0aaa.hlp.
  1846. Recognizing a 3174
  1847.  
  1848. The second diagnostic test uses a hardware command (Read Partition Query)  that
  1849. is  defined  by  IBM, but is not implemented on all 3270-type equipment.  There
  1850. is, thus, the same danger as in the first test, but the danger  appears  to  be
  1851. slight.    Indeed,  both  CMS  and  TSO allow a user program to know in advance
  1852. whether a Query is permitted.  The Query  response  consists  of  one  or  more
  1853. structured fields, and the 3174 AEA ASCII Graphics system (the only device with
  1854. the AEA style of transparency) is easily identified by the appearance and  con-
  1855. tent  of  a particular type of field.  In fact, it is possible to tell from the
  1856. Query data whether the particular  3174  line  is  allowed  to  use  the  ASCII
  1857. Graphics  transparency.  Therefore, this test has three possible outcomes: Ker-
  1858. mit may detect a transparency-enabled 3174 line (and set CONTROLLER to AEA); it
  1859. may  detect  an  incapable  3174  line  (and set CONTROLLER to NONE); or it may
  1860. detect "none of the above" (and set CONTROLLER to GRAPHICS).  Thus, aside  from
  1861. the  exceptions  already noted, GRAPHICS simply means that the front end either
  1862. supports SAS-style transparency or none at all.
  1863.  
  1864.  
  1865. Fallback positions
  1866.  
  1867. What should you do when the automatic detection fails?   Obviously,  the  first
  1868. thing is Be Prepared.  Often, the misbehavior of VTAM can be halted by pressing
  1869. ENTER or PA1, so you should be sure to know how to generate a PA1  when  trying
  1870. out  Kermit on an unfamiliar type of protocol converter.  Also, you should know
  1871. what kind of  transparency  to  expect  for  the  front  end  and  verify  that
  1872. Kermit-370 has, in fact, set CONTROLLER appropriately.  This means checking the
  1873. list of devices in the Kermit distribution file ik0aaa.hlp.  If your configura-
  1874. tion  is  listed  as unsupported, you may be wasting your time, but the list is
  1875. not necessarily up-to-date.  If your configuration is not listed  at  all,  you
  1876. have  the opportunity to be a pioneer and report your findings back to Columbia
  1877. for inclusion in future editions of the list.  There are a few rules  of  thumb
  1878. for quickly deducing the controller type by reading the manuals for the device;
  1879. the manuals may not be specific enough, but this is clearly the easiest way  of
  1880. determining whether Kermit can support a given device and which controller type
  1881. is applicable.    The  rules  are  as  follows  (in  order  of  simplicity  and
  1882. likelihood):
  1883.  
  1884.    1. GRAPHICS or SERIES1 may be implied when the device has a transparent
  1885.       or graphics mode described as compatible with that  of  a  supported
  1886.       device listed in ik0aaa.hlp.
  1887.  
  1888.    2. SERIES1  is  implied when the device runs the "Yale ASCII Communica-
  1889.       tion System" or something with a similar name.
  1890.  
  1891.    3. GRAPHICS is implied if the manual mentions the SAS Institute in  the
  1892.       context of ASCII graphics.
  1893.  
  1894.    4. GRAPHICS  is implied when output transparent data may be preceded by
  1895.       a WCC (Write Control Character) and 70 (hex).
  1896.  
  1897.    5. SERIES1 is implied when transparent data must be preceded by  a  WCC
  1898.       and either 115D7F110005 (write-read) or 115D7F110000 (write-only).
  1899.  
  1900.    6. GRAPHICS  or  SERIES1 may be implied when some of the manufacturer's
  1901.       other products are listed in ik0aaa.hlp, and all are shown as  being
  1902.       of one type.
  1903.  
  1904.    7. If  none of the above rules apply, but the manuals describe a trans-
  1905.       parent mode in detail, the device may be a totally new  type.    The
  1906.       distribution  file  ik0con.hlp has hints on implementing Kermit sup-
  1907.       port for the new type.
  1908.  
  1909.    8. If nothing else works, you can probably use FULLSCREEN mode, as long
  1910.       as the micro Kermit supports it.
  1911.  
  1912. If  Kermit tries to transfer a file with the wrong CONTROLLER value, there is a
  1913. distressing possibility for the session to lock or, at least, appear  to  lock.
  1914. When  and  if  this  happens,  be  sure  to connect back to the mainframe, type
  1915. "STOP", and press ENTER several times (perhaps as  many  as  15  times)  before
  1916. taking any drastic steps like breaking the connection.  "STOP" is a special es-
  1917. cape mechanism for getting out of Kermit protocol  mode  quickly.    Kermit-370
  1918. recognizes such a request in most situations where terminal I/O is not entirely
  1919. frozen.  Sometimes, apparent lock-ups are due to something as simple as  incor-
  1920. rect  parity settings in the micro Kermit, so always check the basic communica-
  1921. tion settings and, if necessary, experiment  before  trying  a  different  CON-
  1922. TROLLER type.  Also, to avoid unnecessary confusion, check for the existence of
  1923. a Kermit initialization file (possibly created by the installer) which could be
  1924. re-setting  CONTROLLER  after  the  automatic  procedure  has finished.  Such a
  1925. re-setting is a poor idea in an initialization file, even a personal  one,  un-
  1926. less there is absolutely only one kind of communications equipment on your sys-
  1927. tem.
  1928.  
  1929. If file transfers do not work at first, it is best to do the  following  before
  1930. trying again:
  1931.  
  1932.    1. Reduce the packet size to no more than 80 at both ends.
  1933.  
  1934.    2. Enable 8th-bit quoting at both ends.
  1935.  
  1936.    3. Set SEND PARITY MARK in Kermit-370.
  1937.  
  1938. If  those  changes do not make transfers work, the next remedial action depends
  1939. on the symptoms of failure.
  1940.  
  1941.    - No packets exchanged and session locked up after reconnecting: change
  1942.      packet characters in both directions.
  1943.  
  1944.    - No  packets  exchanged,  but  no  lockup: change packet characters or
  1945.      parity.
  1946.  
  1947.    - Always multiple retries of third or fourth packet:  reduce  receiving
  1948.      packet size.
  1949.  
  1950.    - Multiple  retries  after random number of packets: check hardware and
  1951.      cables.
  1952.  
  1953.    - Multiple retries after file-dependent number of  packets:  check  for
  1954.      equipment  that intercepts one or more printable characters or reduce
  1955.      the packet size.
  1956.  
  1957. When all else fails, you should be ready to reset CONTROLLER by  hand  and  try
  1958. again.    The  change  most likely to be necessary is from GRAPHICS to SERIES1.
  1959. However, it is conceivable that the installer has modified Kermit-370  at  your
  1960. location  to  force  the  CONTROLLER setting from the start, in which case, you
  1961. might need to go the other way.  Normally,  Kermit's  diagnostic  procedure  at
  1962. start-up takes one or two seconds (because of programmed delays), so you should
  1963. be suspicious if the Kermit prompt appears  immediately  after  you  start  the
  1964. program.    The  only  initial CONTROLLER setting that you should not change by
  1965. hand is NONE, which means that Kermit-370 has recognized a 3174 AEA  line  that
  1966. is  not configured for file transfer (or else the Kermit installer has a warped
  1967. sense of humor).
  1968.  
  1969. If no amount of experimenting gets a transparent mode to work, it  is  time  to
  1970. recheck  the list of supported devices and the age of your equipment.  If yours
  1971. is very old, it may require new microcode or some other  software  or  hardware
  1972. upgrade.    In any case, if your results (whether positive or negative) are not
  1973. already shown in ik0aaa.hlp, you should report them to Columbia so that  others
  1974. may profit by your experience.
  1975.  
  1976.  
  1977. 1.7. After Returning from Kermit-370
  1978.  
  1979. When  Kermit-370  receives a QUIT or EXIT subcommand or finishes the subcommand
  1980. or subcommands specified in the original command string  that  invoked  Kermit,
  1981. control is returned to the caller.  Before returning, Kermit-370 closes any ac-
  1982. tive TAKE files (the EXIT or QUIT subcommand may be issued from a  TAKE  file).
  1983. On  return,  the completion code is set from the current error status according
  1984. to the codes in Table 1-4.
  1985.  
  1986. -------------------------------------------------------------------------------
  1987.  
  1988. Code  Symbol  Error Message
  1989.  0    NOE     No errors
  1990.  1    NFT     No file transfers yet
  1991.  2    TRC     Transfer cancelled
  1992.  3    USC     Invalid server command
  1993.  4    TIE     Terminal I/O error
  1994.  5    BPC     Bad packet count or chksum
  1995.  6    IPS     Invalid packet syntax
  1996.  7    IPT     Invalid packet type
  1997.  8    MIS     Lost a packet
  1998.  9    NAK     Micro sent a NAK
  1999. 10    ABO     Micro aborted
  2000. 11    FNE     Invalid file name
  2001. 12    FNF     File not found
  2002. 13    FUL     Disk or file is full
  2003. 14    DIE     Disk I/O error
  2004. 15    MOP     Missing operand
  2005. 16    SYS     Illegal system command
  2006. 17    KCE     Kermit command error
  2007. 18    TIM     No packet received
  2008. 19    RTR     Records truncated
  2009. 20    COM     Bad communication line
  2010. 21    PTY     8th-bit quote not set
  2011. 22    FTS     File too short
  2012. 23    SOH     Missing start-of-packet
  2013. 24    OPT     Option error on filespec
  2014. 25    DSP     Unable to dispose of file
  2015.  
  2016.               Table 1-4:  Error messages and codes for Kermit-370
  2017.  
  2018.  
  2019. -------------------------------------------------------------------------------
  2020.  
  2021. The error codes in Table 1-4 bear no relationship to the severity  of  the  as-
  2022. sociated error conditions, aside from the assignment of code 0.  The underlying
  2023. rationale is that the only current generic system for the treatment of  comple-
  2024. tion  codes is to take a non-zero code as an indication of error.  Indeed, Ker-
  2025. mit returns a completion code of 0 when "error" condition 1 holds.
  2026.  
  2027.  
  2028. 1.8. What's New
  2029.  
  2030. Below is a list of the changes in Version 4.2.3 of Kermit-370.
  2031.  
  2032.    1. Compatibility with the (aging) F-level assembler.
  2033.  
  2034.    2. Support for LATIN2, LATIN3, TRANSPARENT, CP870, CP905, and CP880, as
  2035.       well as the aliases L1, L2, and L3.
  2036.  
  2037.    3. Support for IBM 3174 ASCII Graphics mode.
  2038.  
  2039.    4. Support for REMOTE PRINT, REMOTE MAIL, and REMOTE SUBMIT.
  2040.  
  2041.    5. Improved  error message for bad packet-size, new alias PACKET-LENGTH
  2042.       for PACKET-SIZE.
  2043.  
  2044.    6. Correct observance of FILE COLLISION for all files in a group.
  2045.    7. Ignoring  spurious  flow-control  "packets"   from   (for   example)
  2046.       MS-Kermit.
  2047.  
  2048.    8. Support for new locking-shift Kermit protocol.
  2049.  
  2050.    9. Support for Japanese Kanji file transfer.
  2051.  
  2052.   10. New FULLSCREEN controller type.
  2053.  
  2054.   11. New HINTS subcommand.
  2055.  
  2056.   12. More graceful recovery from terminal I/O errors and exceptions.
  2057.  
  2058.   13. Support for SNA LU1 3770-type devices and 8-bit, no-parity devices.
  2059.  
  2060.   14. Automatic  conversion  of EBCDIC printer carriage control into ASCII
  2061.       control characters.
  2062.  
  2063.   15. Support for STOP command on "dumb" 3270 terminals and  PCI  protocol
  2064.       converters.
  2065.  
  2066.   16. New efficiency display in STATUS report, based on SPEED setting.
  2067.  
  2068.   17. 8-bit XECHO output.
  2069.  
  2070.   18. Control prefixing for C1 controls.
  2071.  
  2072.   19. New VERSION subcommand.
  2073.  
  2074.   20. Improved debugging facilities.
  2075.  
  2076.  
  2077. 1.9. What's Missing
  2078.  
  2079. Work  on  Kermit-370 will continue.  Features that need to be improved or added
  2080. include:
  2081.  
  2082.    - Implement file archiving.
  2083.  
  2084.    - Implement file transfer checkpointing.
  2085.  
  2086.    - Add SET REPEAT subcommand.
  2087.  
  2088.    - Improve Kermit-370 operation as a local Kermit.
  2089.  
  2090.    - Implement public server mode.
  2091.  
  2092.    - Add new SET FILE LONGLINE DISCARD option to allow multi-file transfer
  2093.      to proceed past a truncation problem.
  2094.  
  2095.    - System-specific upgrades; see the respective chapters for details.
  2096.  
  2097. Anyone interested in working on these or other improvements should first get in
  2098. touch with the Center for Computing Activities at Columbia University  to  find
  2099. out if someone else has already begun a similar project (and, if so, who).
  2100.  
  2101.  
  2102. 1.10. Further Reading
  2103.  
  2104. Below is a list of references for some of the material in this chapter.
  2105.  
  2106.    1. About  Type:  IBM's  Technical Reference for 240-Pel Digitized Type,
  2107.       S544-3156-02 (1989).  This manual contains  visual  tables  of  many
  2108.       EBCDIC  code  pages  and a comprehensive list of character names and
  2109.       acronyms.
  2110.  
  2111.    2. IBM System/370 Reference Summary, GX20-1850-3 (1976).   This  refer-
  2112.       ence card contains EBCDIC and ASCII character codes.
  2113.  
  2114.    3. IBM   VS   Fortran   Application  Programming:  Language  Reference,
  2115.       GC26-3986-1 (1982).  Appendix E contains a table of EBCDIC and ASCII
  2116.       characters with an implied full 256-byte translation table.
  2117.  
  2118.    4. IBM  3174  Character  Set Reference, GA27-3831-02 (1990).  Chapter 5
  2119.       contains visual tables of many EBCDIC code pages.
  2120.  
  2121.    5. Info-Kermit Digest Vol. 11 #1 (1989).   This  issue  contains  draft
  2122.       specifications of some Kermit protocol extensions.
  2123.  
  2124.    6. ISO  International  Register of Coded Character Sets to be used with
  2125.       Escape Sequences (1989).  This (very large)  document  has  complete
  2126.       and  unambiguous  descriptions of standard coded character sets.  It
  2127.       can be obtained from the ECMA.
  2128.  
  2129.    7. Kermit, A File Transfer Protocol by Frank  da  Cruz;  Digital  Press
  2130.       (1987).    This  book  contains a thorough description of the Kermit
  2131.       protocol and services with copious examples.
  2132.  
  2133.    8. Kermit distribution file ISOK5.TXT (1990).  This  preliminary  draft
  2134.       describes  the  new  transfer  protocol, including the international
  2135.       character-set support.
  2136.  
  2137.    9. Kermit News Vol. 3 #1, p.5, "Dynamic Packet  Size  Control"  (1988).
  2138.       This article describes an algorithm for optimizing Kermit throughput
  2139.       in the face of line noise.
  2140.  
  2141.   10. Kermit News #4, p.16, "International Character Sets" (1990).    This
  2142.       article discusses the new transfer protocol.
  2143.  
  2144.   11. ASCII  and  EBCDIC Character Set and Code Issues in Systems Applica-
  2145.       tions Architecture, SHARE white paper by Edwin Hart  (1989).    This
  2146.       document,  available as file SHARE REQUIRE from LISTSERV@JHUVM, lays
  2147.       out general considerations for character codes and translatability.
  2148. 2. IBM MVS/TSO KERMIT
  2149.  
  2150. Program:       John Chandler  (Harvard/Smithsonian  Center  for  Astrophysics);
  2151.                contributions  from Vace Kundakci and Daphne Tzoar (Columbia U),
  2152.                Bob Shields (U. Maryland), Greg Small (UC Berkeley),  Bob  Bolch
  2153.                and  Steve  Blankinship  (Triangle),  Ron  Rusnak  (U. Chicago),
  2154.                Charles Painter (U.  Toronto),  Roger  Fajman  and  Dale  Wright
  2155.                (NIH), Andre Pirard (U. Liege)
  2156. Language:      IBM/370 Assembler
  2157. Documentation: John Chandler (CfA)
  2158. Version:       4.2.0 (90/3/13)
  2159. Date:          1990 May
  2160.  
  2161.  
  2162. Kermit-TSO Capabilities At A Glance:
  2163.  
  2164.   Local operation:                   No
  2165.   Remote operation:                  Yes
  2166.   Transfers text files:              Yes
  2167.   Transfers binary files:            Yes
  2168.   Wildcard send:                     Yes
  2169.   ^X/^Z interruption:                Yes (through micro)
  2170.   Filename collision avoidance:      Yes
  2171.   Can time out:                      Yes (line mode only)
  2172.   8th-bit prefixing:                 Yes
  2173.   Repeat count prefixing:            Yes
  2174.   Alternate block checks:            Yes
  2175.   Terminal emulation:                No
  2176.   Communication settings:            No
  2177.   Transmit BREAK:                    No
  2178.   Packet logging:                    Yes
  2179.   Transaction logging:               Yes
  2180.   Session logging:                   No
  2181.   Raw transmit:                      Yes (no prompts)
  2182.   Sliding window:                    No
  2183.   Long packets:                      Yes
  2184.   Act as server:                     Yes
  2185.   Talk to server:                    Yes
  2186.   Advanced server functions:         Yes
  2187.   Advanced commands for servers:     Yes
  2188.   Local file management:             Yes
  2189.   Handle Attribute Packets:          Yes
  2190.   Command/init files:                Yes
  2191.   Command macros:                    No
  2192.  
  2193.  
  2194. TSO Specifics of Kermit-370:
  2195.  
  2196.   Global INIT file:                  'SYS1.KERMINI'
  2197.   User INIT file:                    KERMINI
  2198.   Debug packet log:                  KER.LOG
  2199.   Server reply log:                  KER.REPLY
  2200.   Mail command:                      KERMAIL filespec LIST(users)
  2201.   Print command:                     KERMPRT filespec OPTIONS(options)
  2202.   Submit command:                    KERMSUB filespec OPTIONS(options)
  2203.   Maximum packet size:               1913 (SERIES1), 1024 (TTY)
  2204.   Maximum disk LRECL:                32760
  2205.  
  2206. Kermit-TSO  is a member of the generic Kermit-370 family and shares most of the
  2207. features and capabilities of the group.  As its name implies, Kermit-TSO is the
  2208. variant  of  Kermit-370  that  runs  under  the  MVS/TSO operating system.  The
  2209. primary documentation for Kermit-TSO is actually the chapter on Kermit-370 (en-
  2210. titled IBM 370 Kermit), which describes general properties; the present chapter
  2211. assumes the reader is familiar with that material.  Only the  details  specific
  2212. to  TSO  operation will be discussed here, e.g., command syntax relating to the
  2213. TSO file system or commands not offered in general by Kermit-370.
  2214.  
  2215.  
  2216. 2.1. The MVS/TSO File System
  2217.  
  2218. The features of the TSO file system of greatest interest to  Kermit  users  are
  2219. the  format of file specifications (filespecs) and the concept of records.  The
  2220. latter is described in the Kermit-370 chapter.
  2221.  
  2222. The MVS/TSO filespec (called the data set name or DSN) takes the form of tokens
  2223. (known  as  qualifiers)  of  up to 8 alphanumeric characters each, separated by
  2224. periods.  Each qualifier must begin with an alphabetic or  national  character.
  2225. The  total length must be no more than 44 characters, including periods.  To be
  2226. precise, a DSN may contain uppercase letters, digits, and the  special  charac-
  2227. ters  "$"  (dollar sign), "#" (number sign), "@" (at sign), and "-" (hyphen) in
  2228. addition to the separating periods.  Other characters must not be included.
  2229.  
  2230. There is another, structural restriction on data set names from the  fact  that
  2231. TSO  data sets are all cataloged.  In a standard MVS catalog, each qualifier of
  2232. each DSN is associated with an index of the same name.  The index is a  hierar-
  2233. chical  catalog  component which points downward either to a list of next-level
  2234. indices or to a data set, but never to both.  Consequently, a cataloged DSN  is
  2235. a  chain  of indices corresponding one-for-one with DSN qualifers, and the last
  2236. index is a pointer to the data set itself.  While there  may  be  many  indices
  2237. with  the  same  name,  no  two such duplicates may both be chained to the same
  2238. next-higher-level index, so  that,  if  DSN's  are  considered  as  strings  of
  2239. qualifiers  (not  of characters), no DSN can be a major substring of any other.
  2240. For example, if the name 'A.BB.C'  exists  in  the  catalog,  then  'A.BB'  and
  2241. 'A.BB.C.X'  are  illegal,  but  'A.B', 'A.BB.Y', 'A.BBB', and 'A.BB.BB' are all
  2242. legal.  Although there is a newer form of catalog, known as IFC, which  removes
  2243. this substring restriction, it is still good practice to avoid violating it be-
  2244. cause there are still sites that use the older form.
  2245.  
  2246. A DSN given in its entirety (as in the foregoing  examples)  is  called  "fully
  2247. qualified" and must be enclosed in single quotes when entered in TSO.  However,
  2248. by convention (and by definition) the first qualifier of each data set  belong-
  2249. ing  to  a  given user must be the user's logon ID, and, by default, that ID is
  2250. the assumed prefix in TSO when a DSN is not enclosed in quotes.   In  practice,
  2251. then,  names  are  abbreviated by omitting the quotes and the prefix.  The most
  2252. common type of name, in fact, consists of the prefix plus two  more  qualifiers
  2253. giving  the  data  set's  name  and type, respectively, so that many files have
  2254. DSN's that correspond exactly to  the  canonical  Kermit  representation  of  a
  2255. filespec.    For  instance,  TEST.FORT is the source of a Fortran program named
  2256. TEST, and its fully qualified DSN would be 'userid.TEST.FORT', where userid  is
  2257. the owner's logon ID.
  2258.  
  2259. While  this  description  is  complete as far as it goes, it omits an important
  2260. feature that is widely used in organizing files under MVS and TSO, namely,  the
  2261. partitioned data set (PDS).  A PDS is a data set like any other, except that it
  2262. has members, each of which can usually be treated as a file in its  own  right.
  2263. In  fact,  with  QSAM (the file access method employed by Kermit and many other
  2264. applications), only members, and not the whole PDS, may  be  read  or  written.
  2265. Thus,  the term "file", as used in this chapter and the Kermit-370 chapter, may
  2266. refer to either a PDS member or an ordinary data set, but not to a  PDS.    The
  2267. notation  for  a PDS member consists of the member name enclosed in parentheses
  2268. and appended to the DSN (and the whole enclosed in quotes if the DSN  is  fully
  2269. qualified).    For  example, if the Fortran program TEST were copied into a PDS
  2270. called DEBUG.FORT, it would then be known as
  2271.  
  2272.     DEBUG.FORT(TEST)
  2273.  
  2274. Although the member name is written together with the DSN, it and the surround-
  2275. ing  parentheses  are not really part of the DSN and are not counted toward the
  2276. 44-character limit.  Still, a member name must conform to the rules for  a  DSN
  2277. qualifier and, in addition, must not contain any hyphens.
  2278.  
  2279. All  these  properties of DSN's come into play when a file is being received by
  2280. Kermit-TSO because a valid DSN must be generated for the new data set.  For ex-
  2281. ample,  any  invalid character in the supplied filespec is replaced by a number
  2282. sign (or converted to uppercase if it is  a  lowercase  letter).    Also,  each
  2283. qualifier  (and  the member name, if any) is prefixed with a number sign (if it
  2284. does not already begin with an alphabetic or national character) and then shor-
  2285. tened,  if  necessary,  to  eight  characters.    If  no  filespec is supplied,
  2286. Kermit-TSO creates a default DSN of "$.$".  The DSN is expanded  to  its  fully
  2287. qualified form and then truncated at 44 characters, if need be.
  2288.  
  2289. The  DSN  prefix, which defaults to the user's logon ID, is similar to a device
  2290. specification on microcomputer systems: it selects an area of disk storage, and
  2291. it usually need not be specified.  In some ways, the prefix is also like a disk
  2292. directory designator, since the file system structure  is  hierarchical.    For
  2293. this  reason,  the  Kermit concept of the "working directory" is equated with a
  2294. particular DSN prefix under Kermit-TSO.  The current "working directory" is the
  2295. collection of all data sets whose names begin with the current prefix, and file
  2296. transfers take place to and from that area unless  a  fully  qualified  DSN  is
  2297. given.
  2298.  
  2299. To  provide compatibility with other operating systems, when Kermit-TSO sends a
  2300. file, it ordinarily makes a file header with only the last  two  qualifiers  of
  2301. the  full DSN (or only the member name plus the last qualifier in the case of a
  2302. PDS member).  On the other hand, extra information may be added by way  of  the
  2303. SET FOREIGN subcommand.
  2304.  
  2305. Although  TSO  data  sets  are  cataloged, MVS allows uncataloged data sets  as
  2306. well, and Kermit-TSO can download such files, as long as the user specifies the
  2307. proper  disk  volume  via  the  SET  FILE VOLUME subcommand.  In principle, un-
  2308. cataloged data sets may have names with illegal characters or qualifiers longer
  2309. than 8 characters, but such names are not recognized by Kermit-TSO.
  2310.  
  2311. Kermit-TSO  allows a group of files to be specified in a single filespec by in-
  2312. cluding the special "wildcard" character  "*",  which  matches  any  string  of
  2313. characters  (even  a  null  string) anywhere either in the DSN proper or in the
  2314. member name, if any.  Only one * may be used in a filespec.  Here are some  ex-
  2315. amples:
  2316.  
  2317.   *.COBOL         All  files of type COBOL (all COBOL source files) in the cur-
  2318.                   rent working directory.
  2319.  
  2320.   BATCH*H.FORT    All files in the current directory which begin with BATCH and
  2321.                   which  end  with  H.FORT.  This would not include BATCH.FORT,
  2322.                   however.
  2323.  
  2324. TSO files, like those in other IBM 370 systems, are  record-oriented  (see  the
  2325. introduction  to the Kermit-370 chapter).  In particular, TSO files are charac-
  2326. terized by record format (RECFM), which may be fixed-length, varying-length, or
  2327. undefined-length;  by  maximum record length (LRECL); and by maximum block size
  2328. (BLKSIZE).  Fixed-length and varying-length records can be (and, under  Kermit,
  2329. always are) combined into blocks, but undefined-length records cannot.  Indeed,
  2330. by convention, they have no logical record length, only a maximum  block  size.
  2331. Records  (and  blocks)  in  TSO  files  may  be  up  to  32760  bytes long, but
  2332. varying-length record blocks use four bytes to specify the  block  length  and,
  2333. therefore,  place an effective limit of 32756 on the records.  Indeed, the data
  2334. portion of such records is limited to 32752 bytes.
  2335.  
  2336. Another file system feature of occasional interest is the  means  of  reporting
  2337. errors.  When Kermit-TSO encounters a disk error, it attempts to prepare an ex-
  2338. planatory message for inclusion in the STATUS report.  The  primary  method  is
  2339. the standard SYNADAF macro.
  2340.  
  2341. MVS/TSO  allows,  but  does not encourage, the use of passwords  to protect in-
  2342. dividual data sets.  When a password is needed for file access, it  is  entered
  2343. immediately  after  the filespec, separated only by a slash ("/").  In the case
  2344. of a fully-qualified DSN, the password must  be  after  the  closing  quotation
  2345. mark.
  2346. 2.2. Program Operation
  2347.  
  2348. At  startup time, Kermit-TSO looks for two initialization files, 'SYS1.KERMINI'
  2349. and 'userid.KERMINI' (where, as before, userid is the user's logon  ID).    The
  2350. latter file would also be known as just KERMINI.  The file 'SYS1.KERMINI' would
  2351. be maintained by a systems programmer, but KERMINI would be maintained  by  the
  2352. user.
  2353.  
  2354. Three  parameters  in  the user's profile (the character delete and line delete
  2355. and intercom) are disabled during protocol mode (and  restored  afterwards)  to
  2356. prevent  any conflict in case either of these characters has been defined to be
  2357. printable.  The settings in effect when Kermit starts up are saved as a sort of
  2358. "normal"  status snapshot (as opposed to the "protocol" status just described).
  2359. The protocol status is selected whenever Kermit enters protocol mode,  and  the
  2360. normal status is selected when Kermit leaves protocol mode.  Note: if Kermit is
  2361. interrupted in the  midst  of  a  transfer  or  while  in  server  mode,  these
  2362. parameters  will  be left with peculiar settings (namely, the protocol status),
  2363. and they may need to be restored by hand.
  2364.  
  2365. Although TSO does not allow an application program to take control of  terminal
  2366. synchronization  on  "TTY"  lines, the various full-screen emulation front ends
  2367. are quite a different matter.  The standard IBM handshake (XON) is unnecessary,
  2368. for  example,  with  a 7171 or 4994 because the front end itself turns the line
  2369. around with essentially no delay in transparent mode.  Thus, handshaking should
  2370. be suppressed for "SERIES1" devices (the micro Kermit should have HANDSHAKE set
  2371. OFF, and Kermit-TSO should have  HANDSHAKE  set  to  0).    Since  the  generic
  2372. Kermit-370  default  handshake  (XON) is retained in Kermit-TSO, the subcommand
  2373. "SET HANDSHAKE 0" is a good candidate for inclusion the  KERMINI  file  of  any
  2374. user who habitually uses "SERIES1" lines.
  2375.  
  2376.  
  2377. Interactive Operation:
  2378.  
  2379. To  run Kermit-TSO interactively, invoke the program from TSO by typing KERMIT.
  2380. When you see the prompt,
  2381.  
  2382.     Kermit-TSO>
  2383.  
  2384. you may type a Kermit subcommand.  When the subcommand completes, Kermit issues
  2385. another  prompt.    The cycle repeats until you exit from the program.  For ex-
  2386. ample:
  2387.  
  2388.     .KERMIT
  2389.  
  2390.     Kermit-TSO Version 4.2.0 (90/3/13)
  2391.     Enter ? for a list of valid commands
  2392.  
  2393.     Kermit-TSO>send foo.*
  2394.  
  2395.       Files beginning with FOO are sent
  2396.  
  2397.     Kermit-TSO>receive test.spss
  2398.  
  2399.       File is received and called TEST.SPSS
  2400.  
  2401.     Kermit-TSO>exit
  2402.  
  2403.  
  2404. Command Line Invocation:
  2405.  
  2406. Kermit-TSO may also be invoked with command line arguments from TSO.   The  ar-
  2407. guments  are interpreted as a subcommand to be executed by Kermit after comple-
  2408. tion of the initialization.  For instance:
  2409.  
  2410.     .KERMIT send test.fort
  2411.  
  2412. Kermit will exit and return to TSO after completing the specified subcommand.
  2413.  
  2414.  
  2415. CLIST Operation:
  2416.  
  2417. Like other TSO programs, Kermit-TSO may be invoked from a CLIST.    Subcommands
  2418. can  be  passed to Kermit using the program input stack and/or command line ar-
  2419. guments.  For example, to start up Kermit-TSO and have it act as a server,  in-
  2420. clude the line:
  2421.  
  2422.     KERMIT server
  2423.  
  2424. To  pass  more  than one subcommand, they must be stacked in the order in which
  2425. they are to be executed.  To start up a Kermit-TSO server with a three  charac-
  2426. ter CRC, create and stack a file with the following:
  2427.  
  2428.     set block 3
  2429.     server
  2430.  
  2431. and  then  invoke  Kermit.    Like  many  utility programs, Kermit-TSO uses the
  2432. GETLINE/PUTLINE service routines for terminal I/O,  and  the  nominally  inter-
  2433. active  subcommands can thus be supplied under program control.  Another way of
  2434. setting up multiple subcommands would be to collect the subcommands into a TAKE
  2435. file  and  then issue the TAKE subcommand via the command line.  CLIST's may be
  2436. executed from Kermit, either directly or from a TAKE file, and CLIST's in  turn
  2437. may  freely issue Kermit subcommands.  The subcommand KERMIT is especially use-
  2438. ful in this context for distinguishing Kermit subcommands from TSO commands.
  2439.  
  2440.  
  2441. Server mode:
  2442.  
  2443. Command execution in server mode is different in several respects  from  normal
  2444. operation.  First of all, some Kermit subcommands are not allowed (see the list
  2445. of subcommands in the Kermit-370 chapter).   Moreover,  command  errors  always
  2446. terminate  any  active  TAKE file.  Also, commands run in a special environment
  2447. with the User Profile temporarily modified.  Another difference is that  Kermit
  2448. intercepts terminal I/O as much as possible and transmits the data to the local
  2449. Kermit as text packets.  The problem with this redirection is that some MVS/TSO
  2450. commands issue terminal I/O directly, so that many messages never appear to the
  2451. local Kermit (except, perhaps, as bad packets).
  2452.  
  2453.  
  2454. 2.3. Kermit-TSO Subcommands
  2455.  
  2456. Kermit-TSO supports all the subcommands described in  the  Kermit-370  chapter.
  2457. In  addition,  there  is  the system-specific subcommand "TSO", which is just a
  2458. synonym for the generic subcommand "HOST".  "TSO" can be  issued  as  a  remote
  2459. Kermit  command  when Kermit-TSO is in server mode.  Also, the "END" subcommand
  2460. is available as a synonym for "EXIT" and "QUIT".
  2461.  
  2462. This section concentrates on the subcommands that have special form or  meaning
  2463. for  Kermit-TSO.    These  are  ordered  alphabetically.    See  the chapter on
  2464. Kermit-370 for further details.
  2465.  
  2466.  
  2467.                               THE CWD SUBCOMMAND
  2468.  
  2469. Syntax: CWD [string or PDSname()]
  2470.  
  2471. The CWD (Change Working Directory) subcommand establishes  a  new  default  DSN
  2472. prefix  or turns prefixing off.  This facility is similar to, but not quite the
  2473. same as, the prefix defined in the User Profile.   The  string,  if  specified,
  2474. must  consist  of  one or more DSN qualifiers, and the first must already be an
  2475. index in the disk catalog.  Subsequent file transfers take place  to  and  from
  2476. the  corresponding  disk  area  whenever a fully qualified DSN (one enclosed in
  2477. quotes) is not given.  The initial prefix is the user's  logon  ID,  i.e.,  the
  2478. same  as the default prefix in the User Profile.  If no prefix is given in this
  2479. subcommand, then prefixing is no longer performed.  The user must be careful to
  2480. remember  the  distinction  between  the prefix defined for Kermit and that for
  2481. TSO.  Pure Kermit subcommands (like SEND and TAKE) always use the  former,  but
  2482. TSO commands (and the TSO-related subcommand TYPE) use the latter.
  2483.  
  2484. An  alternative  form of the CWD subcommand allows specifying the full (but un-
  2485. quoted) name of a PDS followed by paired parentheses.   When  such  a  "working
  2486. directory"  is  in use, a filespec other than a fully qualified DSN is taken to
  2487. be a member name within the PDS.  For that reason, this  form  should  be  used
  2488. cautiously,  since the Kermit-TSO log filespecs (such as KER.LOG and KER.REPLY)
  2489. would be treated the same way.  In particular, it is advisable to turn on debug
  2490. mode  only  when  the Kermit prefix is a partially qualified DSN (once started,
  2491. the log continues to the same data  set  regardless  of  what  happens  to  the
  2492. prefix).
  2493.  
  2494.  
  2495.                            THE DIRECTORY SUBCOMMAND
  2496.  
  2497. Syntax: DIRECTORY [filespec]
  2498.  
  2499. The  DIRECTORY  subcommand  uses the TSO LISTCAT command to display part of the
  2500. data set catalog, i.e., all data sets whose names begin with the qualifiers  in
  2501. the  Kermit  prefix  (if  any)  concatenated  with the given filespec (if any).
  2502. Note: wildcards may not be used, and no options are allowed.   If  you  require
  2503. the LISTCAT options, you must issue a TSO LISTCAT command directly.
  2504.  
  2505.  
  2506.                               THE HELP SUBCOMMAND
  2507.  
  2508. Syntax: HELP [subcommand]
  2509.  
  2510. The HELP subcommand uses TSO HELP facilities to display part or all of the Ker-
  2511. mit help file.  It follows the same syntax.
  2512.  
  2513.  
  2514.                             THE RECEIVE SUBCOMMAND
  2515.  
  2516. Syntax: RECEIVE [filespec]
  2517.  
  2518. The RECEIVE subcommand tells Kermit to receive a file or file  group  from  the
  2519. other  system.    You must issue the corresponding SEND subcommand to the other
  2520. Kermit.
  2521.  
  2522. A filespec in the subcommand indicates what name the incoming  file  should  be
  2523. given.  Wildcards may not be used.  If the filespec is invalid, Kermit-TSO will
  2524. suppress the transfer.  If the optional filespec is omitted (and, in any  case,
  2525. for  all  files  after  the  first  in a group) Kermit-TSO will use the name(s)
  2526. provided by the other Kermit.  If a name is not a legal  DSN,  Kermit-TSO  will
  2527. delete excess characters, change illegal characters to number signs, and so on,
  2528. to create a legal name.
  2529.  
  2530. For the purposes of folding and truncation, the maximum  record  length,  i.e.,
  2531. the  limit  on  the  length  of  data in each record, is "LRECL" if RECFM is F,
  2532. "LRECL"-4 if RECFM is V, and "BLKSIZE" if RECFM is U.
  2533.  
  2534. If the incoming file has the same name as an existing file (either a  data  set
  2535. or  a PDS member), the action taken depends on the FILE COLLISION setting.  The
  2536. possible settings and their meanings are given in the Kermit-370 chapter.   Two
  2537. of the settings (BACKUP and RENAME) require that Kermit-TSO change the incoming
  2538. name so as not to obliterate the pre-existing file.   It  attempts  to  find  a
  2539. unique  name by successively modifying the original and checking for the exist-
  2540. ence of such a file at each  step.    The  procedure  operates  on  the  second
  2541. qualifier  of the full DSN (or the member name in the case of a PDS member) and
  2542. begins by truncating it to seven characters, if  necessary,  and  then  appends
  2543. "0".    If a file by that name exists, Kermit then replaces the "0" with a "1".
  2544. It continues in this manner up to "9", and if an unused name cannot  be  found,
  2545. the  transfer  fails.  If FILE COLLISION has not been set, but the obsolete op-
  2546. tion WARNING has been set ON, however, Kermit-TSO will protect an existing file
  2547. in  a  different  way when the filespec is entered with the RECEIVE subcommand.
  2548. In that case, Kermit will prompt the user for permission to overwrite the file.
  2549.  
  2550.  
  2551.                               THE SEND SUBCOMMAND
  2552.  
  2553. Syntax: SEND [filespec[<options>] [foreign-filespec]][, ...]
  2554.  
  2555. The SEND subcommand causes a file or file group to be sent from TSO to the Ker-
  2556. mit  on  the  other system.  DSN prefixing is done on the filespec in the usual
  2557. way (see also the CWD subcommand).  For details on the options, see the chapter
  2558. on Kermit-370.  Note that a filespec may have both a password and options -- in
  2559. that case, the options must be at the very end.  Blanks may not appear anywhere
  2560. in the string.
  2561.  
  2562. The  filespec  may contain a wildcard "*".  If it does, then all matching files
  2563. will be sent, up to 711 files in all (possibly more in the  case  of  PDS  mem-
  2564. bers).
  2565.  
  2566. The foreign-filespec, if any, is used for the file header of the outgoing file,
  2567. replacing the usual name.type derived from the  MVS/TSO  filespec.    Normally,
  2568. this  form  of  the  SEND  subcommand is used only for single files because the
  2569. foreign-filespec is used only for the first file of a group  (subsequent  files
  2570. having  default  headers).   If both filespecs are omitted for this subcommand,
  2571. Kermit will prompt separately for each, and the respective syntaxes are exactly
  2572. as  described  above.   This prompting mode is especially useful when more than
  2573. one file (or file group) is to be sent, since the command line  is  limited  to
  2574. 130 characters.
  2575.  
  2576. Trailing  blanks  in  a  text  file with RECFM=F are deemed superfluous and are
  2577. stripped off when Kermit-TSO downloads the file.  In order to treat such blanks
  2578. as  significant, you must convert the record format to V, for example, by using
  2579. TSO COPY with the "RECFM V" option.
  2580.  
  2581.  
  2582.                               THE SET SUBCOMMAND
  2583.  
  2584. Syntax: SET parameter [value]
  2585.  
  2586. The SET subcommand establishes or modifies various parameters controlling  file
  2587. transfers.    The following SET parameters are available in Kermit-TSO, but not
  2588. in Kermit-370 in general:
  2589. DELIM               Line delimiter for entering multiple commands.
  2590. FILE
  2591.   BLKSIZE           Block size for incoming file.
  2592.   LRECL             Logical Record length for incoming file.
  2593.   RECFM             Record format for incoming files.
  2594.   SPACE             Allocation unit (in tracks) for incoming files.
  2595.   UNIT              Device type for incoming files.
  2596.   VOLUME            Disk pack for incoming files.
  2597. PREFIX              Default disk area.
  2598.  
  2599.  
  2600. SET DELIM
  2601.  
  2602. Syntax: SET DELIM [letter]
  2603.  
  2604. This sets (or clears) a command line delimiter for interactive  Kermit  subcom-
  2605. mands.    Each occurrence of the delimiter character in the command buffer read
  2606. from the terminal is treated as the start of a new  subcommand.    The  initial
  2607. value is a blank, i.e., no delimiter.
  2608.  
  2609.  
  2610. SET FILE BLKSIZE
  2611.  
  2612. Syntax: SET FILE BLKSIZE number
  2613.  
  2614. This  sets  the  block size for incoming files to a number from 1 to 32760.  In
  2615. the case of fixed-format files, this number is just an upper bound; the  actual
  2616. block  size  is  taken  to  be the largest multiple of the LRECL which does not
  2617. exceed this limit.  The default is 6233.
  2618.  
  2619.  
  2620. SET FILE LRECL
  2621.  
  2622. Syntax: SET FILE LRECL number
  2623.  
  2624. This sets the effective logical record length for incoming files  to  a  number
  2625. from 1 to 32760.  This parameter is not used for files of undefined record for-
  2626. mat.  The default is 80.
  2627.  
  2628.  
  2629. SET FILE RECFM
  2630.  
  2631. Syntax: SET FILE RECFM option
  2632.  
  2633. This sets the record format to use for  incoming  files.    Valid  options  are
  2634. "Fixed",  "Varying"  (the  default),  and  "Undefined".  This parameter is thus
  2635. limited to a subset of the range of possibilities for the MVS/TSO  RECFM.    In
  2636. Kermit-TSO,  all  incoming  files  of fixed or varying format are automatically
  2637. blocked according to the current block size.
  2638.  
  2639. Note: the most common files with RECFM=U, load modules, cannot  be  transported
  2640. directly  using  Kermit, since they contain disk-location pointers.  Such files
  2641. can be "unloaded" using IEHMOVE and then transmitted freely.
  2642.  
  2643.  
  2644. SET FILE SPACE
  2645.  
  2646. Syntax: SET FILE SPACE number
  2647.  
  2648. This sets the track allocation unit for incoming files to a number  from  1  to
  2649. 32760.    The default is 5.  Since data sets are allowed as many as 15 extents,
  2650. this default provides for files up to 75 tracks.
  2651.  
  2652.  
  2653. SET FILE UNIT
  2654.  
  2655. Syntax: SET FILE UNIT type
  2656.  
  2657. This sets the device type or  group  for  incoming  files.    Valid  types  are
  2658. installation-dependent.  The default is blank, which signifies the default UNIT
  2659. group found in the User Attribute Data Set.  This parameter should generally be
  2660. left blank unless the user wishes to create files on a specific disk volume not
  2661. included in the default group (for example, a private volume).
  2662.  
  2663.  
  2664. SET FILE VOLUME
  2665.  
  2666. Syntax: SET FILE VOLUME name
  2667.  
  2668. This  sets  the  disk  volume  for   incoming   files.      Valid   names   are
  2669. installation-dependent,  but  are,  in  any case, no more than six alphanumeric
  2670. characters.  The default is blank (none); in that case, the system chooses  one
  2671. of the available volumes of the current UNIT type.
  2672.  
  2673.  
  2674. SET PREFIX
  2675.  
  2676. Syntax: SET PREFIX [string]
  2677.  
  2678. This subcommand is equivalent to the CWD subcommand (q.v.).
  2679.  
  2680.  
  2681.                               THE TAKE SUBCOMMAND
  2682.  
  2683. Syntax: TAKE filespec
  2684.  
  2685. Execute  Kermit subcommands from the specified file.  The default DSN extension
  2686. is "TAKE", so that datasets with names of the form prefix.name.TAKE can be  ex-
  2687. ecuted  by  typing merely TAKE name.  Names that end with .TAKE or .KERMINI are
  2688. accepted as entered (aside from prefixing), and names in quotes are, of course,
  2689. accepted exactly as entered, but all others are assumed to have a DSN extension
  2690. of .TAKE for the purposes of the TAKE (and GIVE) subcommands.
  2691.  
  2692.  
  2693.                               THE TSO SUBCOMMAND
  2694.  
  2695. Syntax: TSO text of command
  2696.  
  2697. Although Kermit-TSO does not have a full set of its own subcommands for  manag-
  2698. ing  TSO  files,  it provides those services through the operating system.  You
  2699. can issue any TSO command, e.g., to list, type, rename or  delete  files,  send
  2700. messages,  and  so  on.  The TSO subcommand under Kermit is synonymous with the
  2701. HOST subcommand.
  2702.  
  2703.  
  2704. 2.4. How to build an executable Kermit-TSO
  2705.  
  2706. Before attempting to build Kermit-TSO, look in the  Kermit  distribution  under
  2707. IKTKER  for  an  installation  document,  as well as "beware", help, and update
  2708. files, and read them first.  They will probably  contain  information  that  is
  2709. more current than what you see here.
  2710.  
  2711. Kermit-TSO  consists at present of a large assembly (KERMIT.ASM, containing the
  2712. Kermit program) and a small one (DYNALC.ASM, containing a  subroutine  for  al-
  2713. locating  data sets).  Although DYNALC is a single file in the Kermit distribu-
  2714. tion, the source for  Kermit  itself  is  in  many  pieces,  some  generic  for
  2715. Kermit-370 and some specific to TSO.  All the necessary pieces are sequenced in
  2716. columns 73-80 so that the numbers form a strictly increasing sequence when  the
  2717. pieces  are  correctly  "pasted"  together.    It  is important to preserve the
  2718. original sequence numbers so that updates,  if  any,  can  be  applied  to  the
  2719. source.
  2720.  
  2721. To create a runnable version (the hard way):
  2722.  
  2723.    1. Combine  the following "ASM" files from the Kermit distribution into
  2724.       a single file with RECFM=F(B) and LRECL=80: IK0DOC, IK0MAC,  IKTMAC,
  2725.       IK0DEF,  IK0MAI,  IK0COM, IK0CMD, IKTUTL, and IK0PRO.  The resulting
  2726.       file is the composite  source  for  Kermit-TSO,  called  KERMIT.ASM.
  2727.       This  source  must  retain  the original sequence numbers in columns
  2728.       73-80 (in other words, be sure not to resequence the source acciden-
  2729.       tally by using the editor!)
  2730.  
  2731.    2. Copy  or  rename  IKTDYN.ASM  from the Kermit distribution to a file
  2732.       called DYNALC.ASM with RECFM=F(B) and LRECL=80.
  2733.  
  2734.    3. Assemble the source file(s).
  2735.  
  2736.    4. Create the executable load module KERMIT using the  linkage  editor.
  2737.       Be  sure to specify the REUS option.  Kermit is designed to run as a
  2738.       command processor, and so it must be placed in SYS1.CMDLIB or  in  a
  2739.       PDS  concatenated  to SYS1.CMDLIB (for example, via the STEPLIB com-
  2740.       mand).
  2741.  
  2742. To create a runnable version the easy way, extract the batch job from  the  in-
  2743. stallation document, supply a proper JOB card, and submit it.
  2744.  
  2745. If your site's ASCII/EBCDIC translation table for TTY lines does not conform to
  2746. the one listed in the appendix (which in turn conforms to the one given in  the
  2747. IBM   System/370   Reference   Summary),   then   enter   the  appropriate  SET
  2748. ATOE/ETOA/TATOE/TETOA  subcommands  into  'SYS1.KERMINI'.      NOTE:   If   the
  2749. ASCII/EBCDIC translation is not invertible, Kermit will not and cannot work.
  2750.  
  2751. In order to verify the operation of a new version of Kermit-TSO, you may run it
  2752. under TEST using the CP parameter.
  2753.  
  2754.  
  2755. 2.5. What's New
  2756.  
  2757. Below is a list of the TSO-specific features in  Version  4.2.0  of  Kermit-TSO
  2758. added  since  the previous major release, Version 4.1 in January 1989.  For the
  2759. list of generic additions, see the chapter on Kermit-370.
  2760.  
  2761.    1. Implicit CLIST invocation now supported.
  2762.  
  2763.    2. Missing host commands no longer result in ABEND's.    Kermit  simply
  2764.       returns an "invalid host command" indication.
  2765.  
  2766.    3. Migrated  data  sets are automatically recalled, if possible, before
  2767.       attempting to use them.  This includes especially the initialization
  2768.       files.
  2769.  
  2770.    4. Sending PDS members by wildcard has been re-enabled.
  2771.  
  2772.    5. The  "MOD"  date, as defined by ASM2 package, is now used (if it ex-
  2773.       ists) instead of the creation date for sending the date attribute.
  2774.  
  2775.    6. Host commands may now be up to 256 bytes long and be mixed-case.
  2776.  
  2777.    7. NOINTERCOM is set during transfers.
  2778.  
  2779.    8. Avoid truncating foreign filespec for GET/SEND.
  2780.  
  2781.    9. Automatic detection of VTAMTTY as opposed to plain TTY.
  2782.  
  2783.   10. TTY-mode timeouts now work under MVS/XA and MVS/ESA.
  2784.  
  2785.   11. Kermit HELP subcommand now works more than once per session.
  2786.  
  2787.  
  2788. 2.6. What's Missing
  2789.  
  2790. Work on Kermit-TSO will continue.  Features that need to be improved  or  added
  2791. include:
  2792.  
  2793.    - Add support for IBM 3174 AEA transparent mode.
  2794.  
  2795.    - Intercept ABEND's in TSO commands executed under Kermit.
  2796.  
  2797.    - Implement file archiving.
  2798.  
  2799.    - Add a SET REPEAT subcommand.
  2800.  
  2801.    - Finish  SET  LINE,  so that Kermit-TSO can be used as a local Kermit,
  2802.      connecting to a remote host over  an  alternate  communication  port.
  2803.      Add a CONNECT subcommand.
  2804.  
  2805.    - Compute file size for outgoing A-packets and implement the SPACE sub-
  2806.      command.
  2807.  
  2808.    - Reject files known (via  A-packets)  to  be  too  big  for  available
  2809.      storage.
  2810.  
  2811.    - Intercept all terminal output during protocol mode.
  2812.  
  2813. Anyone interested in working on these or other improvements should first get in
  2814. touch with the Center for Computing Activities at Columbia University  to  find
  2815. out if someone else has already begun a similar project (and, if so, who).
  2816. Index
  2817.  
  2818.  
  2819.           3174   1, 5
  2820.           3708   5
  2821.  
  2822.           Alternate lines   7
  2823.           Appending   6
  2824.           ASCII-to-EBCDIC   5
  2825.           Attributes.   See   File   at-
  2826.                   tributes
  2827.  
  2828.           Batch jobs   3
  2829.           Binary files   1, 4, 6
  2830.           Blanks
  2831.              preserving trailing   6
  2832.              stripping   1, 6, 7
  2833.              trailing   1, 7
  2834.           BLKSIZE   1
  2835.           Block check   5
  2836.  
  2837.           Cancelling a file transfer   4
  2838.           Catalog   12
  2839.           Character sets   1, 6, 7, 8
  2840.           CICS   5, 6
  2841.           CLIST   13
  2842.           CMS   5, 6
  2843.           Code pages   1
  2844.                See also   Character sets
  2845.           Collision. See  Filename  col-
  2846.                   lision
  2847.           Command echoing   7, 9
  2848.           Command prefix   3, 4, 7
  2849.           Completion codes   10
  2850.                See also   Error codes
  2851.           Controller   5
  2852.           CRLF   1, 6
  2853.           CSW   5
  2854.           CWD   13
  2855.           Cyrillic   1, 6, 7
  2856.  
  2857.           Data set. See File
  2858.           DCB. See File attributes
  2859.           Debugging   5
  2860.           DIRECTORY   13
  2861.           Discarding files   6, 7, 11
  2862.                See also   DELETE
  2863.           DOS-4   1
  2864.           Dumping storage   5
  2865.  
  2866.           EBCDIC-to-ASCII   5
  2867.           ECHO   3
  2868.                See  also   Command echo-
  2869.                   ing
  2870.           Eighth-bit prefix   8
  2871.           Electronic mail   3
  2872.           End of file   6
  2873.           Error codes   10
  2874.           Extended ASCII   5
  2875.  
  2876.           File attributes   1, 5, 9
  2877.           File disposition   3
  2878.           File renaming   6
  2879.           File truncation   6
  2880.           Filename collision   6, 13
  2881.           Flow control   9
  2882.           Folding   4, 6, 13
  2883.           Foreign   3, 7
  2884.           Front end   1
  2885.           Full screen   3, 9
  2886.  
  2887.           GET   3
  2888.           GIVE   3, 14
  2889.           Greek   1, 7
  2890.  
  2891.           Handshake   7, 9
  2892.           Hebrew   1, 7
  2893.           HELP   13
  2894.           Host commands   3, 7
  2895.  
  2896.           IBM   1, 12
  2897.           Incomplete files   4, 7
  2898.           Initialization files    1,  2,
  2899.                   3, 6, 7, 8, 12, 13, 14
  2900.  
  2901.           Kanji   1, 6, 7
  2902.           Katakana   1, 7
  2903.  
  2904.           Languages   1
  2905.           Line delimiter   14
  2906.           Load modules   14
  2907.           Local   3
  2908.           LOCAL-ECHO   9
  2909.           Log files   12
  2910.           Long packets   4, 8, 9
  2911.           LRECL   1, 6, 12
  2912.  
  2913.           Mail   3
  2914.                See  also      Electronic
  2915.                   mail
  2916.           Margins   7
  2917.           MTS   1
  2918.           MUSIC   5, 6
  2919.           MVS/TSO   12
  2920.  
  2921.           Optimum packet size   4, 7
  2922.           Overwriting files   6
  2923.                See also   Filename  col-
  2924.                   lision
  2925.  
  2926.           Packet size   4, 8
  2927.           Parity   8, 9
  2928.           Partitioned data set   12
  2929.           Passwords   12
  2930.           Prefix.      See      Command,
  2931.                   Eighth-bit, Foreign
  2932.           Prefix   13, 14
  2933.           Printing files   3
  2934.           Prompt   7
  2935.  
  2936.           Qualifier   12
  2937.           Quote. See Prefix
  2938.  
  2939.           Raw transmission   3, 9
  2940.           RECEIVE   3, 4, 13
  2941.           RECFM   1
  2942.           Records   1
  2943.           Remote   3
  2944.           RENAME   6
  2945.           Renaming files   6
  2946.                See also   File renaming
  2947.           ROSCOE   5, 6
  2948.  
  2949.           Screen refresh   9
  2950.           SEND   3, 4, 14
  2951.           SEND delay   6
  2952.           Series/1   1, 5, 12
  2953.           SERVER   4
  2954.           SET   4, 14
  2955.           SHOW   8
  2956.           SNA   1, 5
  2957.           STATUS   9
  2958.           STOP   9
  2959.           Stripping blanks. See Blanks
  2960.           Subcommand prefix. See Command
  2961.                   prefix
  2962.           Submitting jobs   3
  2963.                See also   Batch jobs
  2964.  
  2965.           Tabs   7
  2966.           TAKE   9, 14
  2967.           TDUMP   9
  2968.           TEST   7
  2969.           TGET   5
  2970.           Timeout   7, 8, 9
  2971.           TPUT   5
  2972.           Tracing execution   5
  2973.           Trailing blanks. See Blanks
  2974.           Trailing   blanks,  preserving
  2975.                   14
  2976.           Transaction log   4, 9
  2977.           Translation   1, 8
  2978.           Translation tables   1, 3,  7,
  2979.                   14
  2980.           Transparent mode   3, 9
  2981.           Truncation   4, 6, 13
  2982.                See  also      File trun-
  2983.                   cation
  2984.           TSO   5, 6, 12
  2985.           TTY   1, 5, 9, 12
  2986.           Type   4
  2987.  
  2988.           Uncataloged data sets   12
  2989.           User profile   13
  2990.  
  2991.           Warning   6
  2992.           Wildcards   12, 14
  2993.  
  2994.           XECHO   3
  2995.